# frozen_string_literal: true

# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE

require 'seahorse/client/plugins/content_length'
require 'aws-sdk-core/plugins/credentials_configuration'
require 'aws-sdk-core/plugins/logging'
require 'aws-sdk-core/plugins/param_converter'
require 'aws-sdk-core/plugins/param_validator'
require 'aws-sdk-core/plugins/user_agent'
require 'aws-sdk-core/plugins/helpful_socket_errors'
require 'aws-sdk-core/plugins/retry_errors'
require 'aws-sdk-core/plugins/global_configuration'
require 'aws-sdk-core/plugins/regional_endpoint'
require 'aws-sdk-core/plugins/endpoint_discovery'
require 'aws-sdk-core/plugins/endpoint_pattern'
require 'aws-sdk-core/plugins/response_paging'
require 'aws-sdk-core/plugins/stub_responses'
require 'aws-sdk-core/plugins/idempotency_token'
require 'aws-sdk-core/plugins/invocation_id'
require 'aws-sdk-core/plugins/jsonvalue_converter'
require 'aws-sdk-core/plugins/client_metrics_plugin'
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
require 'aws-sdk-core/plugins/transfer_encoding'
require 'aws-sdk-core/plugins/http_checksum'
require 'aws-sdk-core/plugins/checksum_algorithm'
require 'aws-sdk-core/plugins/request_compression'
require 'aws-sdk-core/plugins/defaults_mode'
require 'aws-sdk-core/plugins/recursion_detection'
require 'aws-sdk-core/plugins/telemetry'
require 'aws-sdk-core/plugins/sign'
require 'aws-sdk-core/plugins/protocols/json_rpc'

module Aws::Athena
  # An API client for Athena.  To construct a client, you need to configure a `:region` and `:credentials`.
  #
  #     client = Aws::Athena::Client.new(
  #       region: region_name,
  #       credentials: credentials,
  #       # ...
  #     )
  #
  # For details on configuring region and credentials see
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
  #
  # See {#initialize} for a full list of supported configuration options.
  class Client < Seahorse::Client::Base

    include Aws::ClientStubs

    @identifier = :athena

    set_api(ClientApi::API)

    add_plugin(Seahorse::Client::Plugins::ContentLength)
    add_plugin(Aws::Plugins::CredentialsConfiguration)
    add_plugin(Aws::Plugins::Logging)
    add_plugin(Aws::Plugins::ParamConverter)
    add_plugin(Aws::Plugins::ParamValidator)
    add_plugin(Aws::Plugins::UserAgent)
    add_plugin(Aws::Plugins::HelpfulSocketErrors)
    add_plugin(Aws::Plugins::RetryErrors)
    add_plugin(Aws::Plugins::GlobalConfiguration)
    add_plugin(Aws::Plugins::RegionalEndpoint)
    add_plugin(Aws::Plugins::EndpointDiscovery)
    add_plugin(Aws::Plugins::EndpointPattern)
    add_plugin(Aws::Plugins::ResponsePaging)
    add_plugin(Aws::Plugins::StubResponses)
    add_plugin(Aws::Plugins::IdempotencyToken)
    add_plugin(Aws::Plugins::InvocationId)
    add_plugin(Aws::Plugins::JsonvalueConverter)
    add_plugin(Aws::Plugins::ClientMetricsPlugin)
    add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
    add_plugin(Aws::Plugins::TransferEncoding)
    add_plugin(Aws::Plugins::HttpChecksum)
    add_plugin(Aws::Plugins::ChecksumAlgorithm)
    add_plugin(Aws::Plugins::RequestCompression)
    add_plugin(Aws::Plugins::DefaultsMode)
    add_plugin(Aws::Plugins::RecursionDetection)
    add_plugin(Aws::Plugins::Telemetry)
    add_plugin(Aws::Plugins::Sign)
    add_plugin(Aws::Plugins::Protocols::JsonRpc)
    add_plugin(Aws::Athena::Plugins::Endpoints)

    # @overload initialize(options)
    #   @param [Hash] options
    #
    #   @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
    #     A list of plugins to apply to the client. Each plugin is either a
    #     class name or an instance of a plugin class.
    #
    #   @option options [required, Aws::CredentialProvider] :credentials
    #     Your AWS credentials used for authentication. This can be any class that includes and implements
    #     `Aws::CredentialProvider`, or instance of any one of the following classes:
    #
    #     * `Aws::Credentials` - Used for configuring static, non-refreshing
    #       credentials.
    #
    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
    #       shared file, such as `~/.aws/config`.
    #
    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
    #
    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
    #       assume a role after providing credentials via the web.
    #
    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
    #       access token generated from `aws login`.
    #
    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
    #       process that outputs to stdout.
    #
    #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
    #       from an EC2 IMDS on an EC2 instance.
    #
    #     * `Aws::ECSCredentials` - Used for loading credentials from
    #       instances running in ECS.
    #
    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
    #       from the Cognito Identity service.
    #
    #     When `:credentials` are not configured directly, the following locations will be searched for credentials:
    #
    #     * `Aws.config[:credentials]`
    #
    #     * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
    #       `:account_id` options.
    #
    #     * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
    #       `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
    #
    #     * `~/.aws/credentials`
    #
    #     * `~/.aws/config`
    #
    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
    #       Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
    #       enable retries and extended timeouts. Instance profile credential fetching can be disabled by
    #       setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
    #
    #   @option options [required, String] :region
    #     The AWS region to connect to.  The configured `:region` is
    #     used to determine the service `:endpoint`. When not passed,
    #     a default `:region` is searched for in the following locations:
    #
    #     * `Aws.config[:region]`
    #     * `ENV['AWS_REGION']`
    #     * `ENV['AMAZON_REGION']`
    #     * `ENV['AWS_DEFAULT_REGION']`
    #     * `~/.aws/credentials`
    #     * `~/.aws/config`
    #
    #   @option options [String] :access_key_id
    #
    #   @option options [String] :account_id
    #
    #   @option options [Boolean] :active_endpoint_cache (false)
    #     When set to `true`, a thread polling for endpoints will be running in
    #     the background every 60 secs (default). Defaults to `false`.
    #
    #   @option options [Boolean] :adaptive_retry_wait_to_fill (true)
    #     Used only in `adaptive` retry mode.  When true, the request will sleep
    #     until there is sufficent client side capacity to retry the request.
    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
    #     not retry instead of sleeping.
    #
    #   @option options [Array<String>] :auth_scheme_preference
    #     A list of preferred authentication schemes to use when making a request. Supported values are:
    #     `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
    #     shared config as `auth_scheme_preference`, the value should be a comma-separated list.
    #
    #   @option options [Boolean] :client_side_monitoring (false)
    #     When `true`, client-side metrics will be collected for all API requests from
    #     this client.
    #
    #   @option options [String] :client_side_monitoring_client_id ("")
    #     Allows you to provide an identifier for this client which will be attached to
    #     all generated client side metrics. Defaults to an empty string.
    #
    #   @option options [String] :client_side_monitoring_host ("127.0.0.1")
    #     Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
    #     side monitoring agent is running on, where client metrics will be published via UDP.
    #
    #   @option options [Integer] :client_side_monitoring_port (31000)
    #     Required for publishing client metrics. The port that the client side monitoring
    #     agent is running on, where client metrics will be published via UDP.
    #
    #   @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
    #     Allows you to provide a custom client-side monitoring publisher class. By default,
    #     will use the Client Side Monitoring Agent Publisher.
    #
    #   @option options [Boolean] :convert_params (true)
    #     When `true`, an attempt is made to coerce request parameters into
    #     the required types.
    #
    #   @option options [Boolean] :correct_clock_skew (true)
    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
    #     a clock skew correction and retry requests with skewed client clocks.
    #
    #   @option options [String] :defaults_mode ("legacy")
    #     See {Aws::DefaultsModeConfiguration} for a list of the
    #     accepted modes and the configuration defaults that are included.
    #
    #   @option options [Boolean] :disable_host_prefix_injection (false)
    #     When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
    #
    #   @option options [Boolean] :disable_request_compression (false)
    #     When set to 'true' the request body will not be compressed
    #     for supported operations.
    #
    #   @option options [String, URI::HTTPS, URI::HTTP] :endpoint
    #     Normally you should not configure the `:endpoint` option
    #     directly. This is normally constructed from the `:region`
    #     option. Configuring `:endpoint` is normally reserved for
    #     connecting to test or custom endpoints. The endpoint should
    #     be a URI formatted like:
    #
    #         'http://example.com'
    #         'https://example.com'
    #         'http://example.com:123'
    #
    #   @option options [Integer] :endpoint_cache_max_entries (1000)
    #     Used for the maximum size limit of the LRU cache storing endpoints data
    #     for endpoint discovery enabled operations. Defaults to 1000.
    #
    #   @option options [Integer] :endpoint_cache_max_threads (10)
    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
    #
    #   @option options [Integer] :endpoint_cache_poll_interval (60)
    #     When :endpoint_discovery and :active_endpoint_cache is enabled,
    #     Use this option to config the time interval in seconds for making
    #     requests fetching endpoints information. Defaults to 60 sec.
    #
    #   @option options [Boolean] :endpoint_discovery (false)
    #     When set to `true`, endpoint discovery will be enabled for operations when available.
    #
    #   @option options [Boolean] :ignore_configured_endpoint_urls
    #     Setting to true disables use of endpoint URLs provided via environment
    #     variables and the shared configuration file.
    #
    #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
    #     The log formatter.
    #
    #   @option options [Symbol] :log_level (:info)
    #     The log level to send messages to the `:logger` at.
    #
    #   @option options [Logger] :logger
    #     The Logger instance to send log messages to.  If this option
    #     is not set, logging will be disabled.
    #
    #   @option options [Integer] :max_attempts (3)
    #     An integer representing the maximum number attempts that will be made for
    #     a single request, including the initial attempt.  For example,
    #     setting this value to 5 will result in a request being retried up to
    #     4 times. Used in `standard` and `adaptive` retry modes.
    #
    #   @option options [String] :profile ("default")
    #     Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
    #     When not specified, 'default' is used.
    #
    #   @option options [String] :request_checksum_calculation ("when_supported")
    #     Determines when a checksum will be calculated for request payloads. Values are:
    #
    #     * `when_supported` - (default) When set, a checksum will be
    #       calculated for all request payloads of operations modeled with the
    #       `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
    #       `requestAlgorithmMember` is modeled.
    #     * `when_required` - When set, a checksum will only be calculated for
    #       request payloads of operations modeled with the  `httpChecksum` trait where
    #       `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
    #       is modeled and supplied.
    #
    #   @option options [Integer] :request_min_compression_size_bytes (10240)
    #     The minimum size in bytes that triggers compression for request
    #     bodies. The value must be non-negative integer value between 0
    #     and 10485780 bytes inclusive.
    #
    #   @option options [String] :response_checksum_validation ("when_supported")
    #     Determines when checksum validation will be performed on response payloads. Values are:
    #
    #     * `when_supported` - (default) When set, checksum validation is performed on all
    #       response payloads of operations modeled with the `httpChecksum` trait where
    #       `responseAlgorithms` is modeled, except when no modeled checksum algorithms
    #       are supported.
    #     * `when_required` - When set, checksum validation is not performed on
    #       response payloads of operations unless the checksum algorithm is supported and
    #       the `requestValidationModeMember` member is set to `ENABLED`.
    #
    #   @option options [Proc] :retry_backoff
    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
    #     This option is only used in the `legacy` retry mode.
    #
    #   @option options [Float] :retry_base_delay (0.3)
    #     The base delay in seconds used by the default backoff function. This option
    #     is only used in the `legacy` retry mode.
    #
    #   @option options [Symbol] :retry_jitter (:none)
    #     A delay randomiser function used by the default backoff function.
    #     Some predefined functions can be referenced by name - :none, :equal, :full,
    #     otherwise a Proc that takes and returns a number. This option is only used
    #     in the `legacy` retry mode.
    #
    #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
    #
    #   @option options [Integer] :retry_limit (3)
    #     The maximum number of times to retry failed requests.  Only
    #     ~ 500 level server errors and certain ~ 400 level client errors
    #     are retried.  Generally, these are throttling errors, data
    #     checksum errors, networking errors, timeout errors, auth errors,
    #     endpoint discovery, and errors from expired credentials.
    #     This option is only used in the `legacy` retry mode.
    #
    #   @option options [Integer] :retry_max_delay (0)
    #     The maximum number of seconds to delay between retries (0 for no limit)
    #     used by the default backoff function. This option is only used in the
    #     `legacy` retry mode.
    #
    #   @option options [String] :retry_mode ("legacy")
    #     Specifies which retry algorithm to use. Values are:
    #
    #     * `legacy` - The pre-existing retry behavior.  This is default value if
    #       no retry mode is provided.
    #
    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
    #       This includes support for retry quotas, which limit the number of
    #       unsuccessful retries a client can make.
    #
    #     * `adaptive` - An experimental retry mode that includes all the
    #       functionality of `standard` mode along with automatic client side
    #       throttling.  This is a provisional mode that may change behavior
    #       in the future.
    #
    #   @option options [String] :sdk_ua_app_id
    #     A unique and opaque application ID that is appended to the
    #     User-Agent header as app/sdk_ua_app_id. It should have a
    #     maximum length of 50. This variable is sourced from environment
    #     variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
    #
    #   @option options [String] :secret_access_key
    #
    #   @option options [String] :session_token
    #
    #   @option options [Array] :sigv4a_signing_region_set
    #     A list of regions that should be signed with SigV4a signing. When
    #     not passed, a default `:sigv4a_signing_region_set` is searched for
    #     in the following locations:
    #
    #     * `Aws.config[:sigv4a_signing_region_set]`
    #     * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
    #     * `~/.aws/config`
    #
    #   @option options [Boolean] :simple_json (false)
    #     Disables request parameter conversion, validation, and formatting.
    #     Also disables response data type conversions. The request parameters
    #     hash must be formatted exactly as the API expects.This option is useful
    #     when you want to ensure the highest level of performance by avoiding
    #     overhead of walking request parameters and response data structures.
    #
    #   @option options [Boolean] :stub_responses (false)
    #     Causes the client to return stubbed responses. By default
    #     fake responses are generated and returned. You can specify
    #     the response data to return or errors to raise by calling
    #     {ClientStubs#stub_responses}. See {ClientStubs} for more information.
    #
    #     ** Please note ** When response stubbing is enabled, no HTTP
    #     requests are made, and retries are disabled.
    #
    #   @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
    #     Allows you to provide a telemetry provider, which is used to
    #     emit telemetry data. By default, uses `NoOpTelemetryProvider` which
    #     will not record or emit any telemetry data. The SDK supports the
    #     following telemetry providers:
    #
    #     * OpenTelemetry (OTel) - To use the OTel provider, install and require the
    #     `opentelemetry-sdk` gem and then, pass in an instance of a
    #     `Aws::Telemetry::OTelProvider` for telemetry provider.
    #
    #   @option options [Aws::TokenProvider] :token_provider
    #     Your Bearer token used for authentication. This can be any class that includes and implements
    #     `Aws::TokenProvider`, or instance of any one of the following classes:
    #
    #     * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
    #       tokens.
    #
    #     * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
    #       access token generated from `aws login`.
    #
    #     When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
    #     will be used to search for tokens configured for your profile in shared configuration files.
    #
    #   @option options [Boolean] :use_dualstack_endpoint
    #     When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
    #     will be used if available.
    #
    #   @option options [Boolean] :use_fips_endpoint
    #     When set to `true`, fips compatible endpoints will be used if available.
    #     When a `fips` region is used, the region is normalized and this config
    #     is set to `true`.
    #
    #   @option options [Boolean] :validate_params (true)
    #     When `true`, request parameters are validated before
    #     sending the request.
    #
    #   @option options [Aws::Athena::EndpointProvider] :endpoint_provider
    #     The endpoint provider used to resolve endpoints. Any object that responds to
    #     `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
    #     `Aws::Athena::EndpointParameters`.
    #
    #   @option options [Float] :http_continue_timeout (1)
    #     The number of seconds to wait for a 100-continue response before sending the
    #     request body.  This option has no effect unless the request has "Expect"
    #     header set to "100-continue".  Defaults to `nil` which  disables this
    #     behaviour.  This value can safely be set per request on the session.
    #
    #   @option options [Float] :http_idle_timeout (5)
    #     The number of seconds a connection is allowed to sit idle before it
    #     is considered stale.  Stale connections are closed and removed from the
    #     pool before making a request.
    #
    #   @option options [Float] :http_open_timeout (15)
    #     The default number of seconds to wait for response data.
    #     This value can safely be set per-request on the session.
    #
    #   @option options [URI::HTTP,String] :http_proxy
    #     A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
    #
    #   @option options [Float] :http_read_timeout (60)
    #     The default number of seconds to wait for response data.
    #     This value can safely be set per-request on the session.
    #
    #   @option options [Boolean] :http_wire_trace (false)
    #     When `true`,  HTTP debug output will be sent to the `:logger`.
    #
    #   @option options [Proc] :on_chunk_received
    #     When a Proc object is provided, it will be used as callback when each chunk
    #     of the response body is received. It provides three arguments: the chunk,
    #     the number of bytes received, and the total number of
    #     bytes in the response (or nil if the server did not send a `content-length`).
    #
    #   @option options [Proc] :on_chunk_sent
    #     When a Proc object is provided, it will be used as callback when each chunk
    #     of the request body is sent. It provides three arguments: the chunk,
    #     the number of bytes read from the body, and the total number of
    #     bytes in the body.
    #
    #   @option options [Boolean] :raise_response_errors (true)
    #     When `true`, response errors are raised.
    #
    #   @option options [String] :ssl_ca_bundle
    #     Full path to the SSL certificate authority bundle file that should be used when
    #     verifying peer certificates.  If you do not pass `:ssl_ca_bundle` or
    #     `:ssl_ca_directory` the the system default will be used if available.
    #
    #   @option options [String] :ssl_ca_directory
    #     Full path of the directory that contains the unbundled SSL certificate
    #     authority files for verifying peer certificates.  If you do
    #     not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
    #     default will be used if available.
    #
    #   @option options [String] :ssl_ca_store
    #     Sets the X509::Store to verify peer certificate.
    #
    #   @option options [OpenSSL::X509::Certificate] :ssl_cert
    #     Sets a client certificate when creating http connections.
    #
    #   @option options [OpenSSL::PKey] :ssl_key
    #     Sets a client key when creating http connections.
    #
    #   @option options [Float] :ssl_timeout
    #     Sets the SSL timeout in seconds
    #
    #   @option options [Boolean] :ssl_verify_peer (true)
    #     When `true`, SSL peer certificates are verified when establishing a connection.
    #
    def initialize(*args)
      super
    end

    # @!group API Operations

    # Returns the details of a single named query or a list of up to 50
    # queries, which you provide as an array of query ID strings. Requires
    # you to have access to the workgroup in which the queries were saved.
    # Use ListNamedQueriesInput to get the list of named query IDs in the
    # specified workgroup. If information could not be retrieved for a
    # submitted query ID, information about the query ID submitted is listed
    # under UnprocessedNamedQueryId. Named queries differ from executed
    # queries. Use BatchGetQueryExecutionInput to get details about each
    # unique query execution, and ListQueryExecutionsInput to get a list of
    # query execution IDs.
    #
    # @option params [required, Array<String>] :named_query_ids
    #   An array of query IDs.
    #
    # @return [Types::BatchGetNamedQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::BatchGetNamedQueryOutput#named_queries #named_queries} => Array&lt;Types::NamedQuery&gt;
    #   * {Types::BatchGetNamedQueryOutput#unprocessed_named_query_ids #unprocessed_named_query_ids} => Array&lt;Types::UnprocessedNamedQueryId&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.batch_get_named_query({
    #     named_query_ids: ["NamedQueryId"], # required
    #   })
    #
    # @example Response structure
    #
    #   resp.named_queries #=> Array
    #   resp.named_queries[0].name #=> String
    #   resp.named_queries[0].description #=> String
    #   resp.named_queries[0].database #=> String
    #   resp.named_queries[0].query_string #=> String
    #   resp.named_queries[0].named_query_id #=> String
    #   resp.named_queries[0].work_group #=> String
    #   resp.unprocessed_named_query_ids #=> Array
    #   resp.unprocessed_named_query_ids[0].named_query_id #=> String
    #   resp.unprocessed_named_query_ids[0].error_code #=> String
    #   resp.unprocessed_named_query_ids[0].error_message #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetNamedQuery AWS API Documentation
    #
    # @overload batch_get_named_query(params = {})
    # @param [Hash] params ({})
    def batch_get_named_query(params = {}, options = {})
      req = build_request(:batch_get_named_query, params)
      req.send_request(options)
    end

    # Returns the details of a single prepared statement or a list of up to
    # 256 prepared statements for the array of prepared statement names that
    # you provide. Requires you to have access to the workgroup to which the
    # prepared statements belong. If a prepared statement cannot be
    # retrieved for the name specified, the statement is listed in
    # `UnprocessedPreparedStatementNames`.
    #
    # @option params [required, Array<String>] :prepared_statement_names
    #   A list of prepared statement names to return.
    #
    # @option params [required, String] :work_group
    #   The name of the workgroup to which the prepared statements belong.
    #
    # @return [Types::BatchGetPreparedStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::BatchGetPreparedStatementOutput#prepared_statements #prepared_statements} => Array&lt;Types::PreparedStatement&gt;
    #   * {Types::BatchGetPreparedStatementOutput#unprocessed_prepared_statement_names #unprocessed_prepared_statement_names} => Array&lt;Types::UnprocessedPreparedStatementName&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.batch_get_prepared_statement({
    #     prepared_statement_names: ["StatementName"], # required
    #     work_group: "WorkGroupName", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.prepared_statements #=> Array
    #   resp.prepared_statements[0].statement_name #=> String
    #   resp.prepared_statements[0].query_statement #=> String
    #   resp.prepared_statements[0].work_group_name #=> String
    #   resp.prepared_statements[0].description #=> String
    #   resp.prepared_statements[0].last_modified_time #=> Time
    #   resp.unprocessed_prepared_statement_names #=> Array
    #   resp.unprocessed_prepared_statement_names[0].statement_name #=> String
    #   resp.unprocessed_prepared_statement_names[0].error_code #=> String
    #   resp.unprocessed_prepared_statement_names[0].error_message #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetPreparedStatement AWS API Documentation
    #
    # @overload batch_get_prepared_statement(params = {})
    # @param [Hash] params ({})
    def batch_get_prepared_statement(params = {}, options = {})
      req = build_request(:batch_get_prepared_statement, params)
      req.send_request(options)
    end

    # Returns the details of a single query execution or a list of up to 50
    # query executions, which you provide as an array of query execution ID
    # strings. Requires you to have access to the workgroup in which the
    # queries ran. To get a list of query execution IDs, use
    # ListQueryExecutionsInput$WorkGroup. Query executions differ from named
    # (saved) queries. Use BatchGetNamedQueryInput to get details about
    # named queries.
    #
    # @option params [required, Array<String>] :query_execution_ids
    #   An array of query execution IDs.
    #
    # @return [Types::BatchGetQueryExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::BatchGetQueryExecutionOutput#query_executions #query_executions} => Array&lt;Types::QueryExecution&gt;
    #   * {Types::BatchGetQueryExecutionOutput#unprocessed_query_execution_ids #unprocessed_query_execution_ids} => Array&lt;Types::UnprocessedQueryExecutionId&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.batch_get_query_execution({
    #     query_execution_ids: ["QueryExecutionId"], # required
    #   })
    #
    # @example Response structure
    #
    #   resp.query_executions #=> Array
    #   resp.query_executions[0].query_execution_id #=> String
    #   resp.query_executions[0].query #=> String
    #   resp.query_executions[0].statement_type #=> String, one of "DDL", "DML", "UTILITY"
    #   resp.query_executions[0].managed_query_results_configuration.enabled #=> Boolean
    #   resp.query_executions[0].managed_query_results_configuration.encryption_configuration.kms_key #=> String
    #   resp.query_executions[0].result_configuration.output_location #=> String
    #   resp.query_executions[0].result_configuration.encryption_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS", "CSE_KMS"
    #   resp.query_executions[0].result_configuration.encryption_configuration.kms_key #=> String
    #   resp.query_executions[0].result_configuration.expected_bucket_owner #=> String
    #   resp.query_executions[0].result_configuration.acl_configuration.s3_acl_option #=> String, one of "BUCKET_OWNER_FULL_CONTROL"
    #   resp.query_executions[0].result_reuse_configuration.result_reuse_by_age_configuration.enabled #=> Boolean
    #   resp.query_executions[0].result_reuse_configuration.result_reuse_by_age_configuration.max_age_in_minutes #=> Integer
    #   resp.query_executions[0].query_execution_context.database #=> String
    #   resp.query_executions[0].query_execution_context.catalog #=> String
    #   resp.query_executions[0].status.state #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED"
    #   resp.query_executions[0].status.state_change_reason #=> String
    #   resp.query_executions[0].status.submission_date_time #=> Time
    #   resp.query_executions[0].status.completion_date_time #=> Time
    #   resp.query_executions[0].status.athena_error.error_category #=> Integer
    #   resp.query_executions[0].status.athena_error.error_type #=> Integer
    #   resp.query_executions[0].status.athena_error.retryable #=> Boolean
    #   resp.query_executions[0].status.athena_error.error_message #=> String
    #   resp.query_executions[0].statistics.engine_execution_time_in_millis #=> Integer
    #   resp.query_executions[0].statistics.data_scanned_in_bytes #=> Integer
    #   resp.query_executions[0].statistics.data_manifest_location #=> String
    #   resp.query_executions[0].statistics.total_execution_time_in_millis #=> Integer
    #   resp.query_executions[0].statistics.query_queue_time_in_millis #=> Integer
    #   resp.query_executions[0].statistics.service_pre_processing_time_in_millis #=> Integer
    #   resp.query_executions[0].statistics.query_planning_time_in_millis #=> Integer
    #   resp.query_executions[0].statistics.service_processing_time_in_millis #=> Integer
    #   resp.query_executions[0].statistics.result_reuse_information.reused_previous_result #=> Boolean
    #   resp.query_executions[0].work_group #=> String
    #   resp.query_executions[0].engine_version.selected_engine_version #=> String
    #   resp.query_executions[0].engine_version.effective_engine_version #=> String
    #   resp.query_executions[0].execution_parameters #=> Array
    #   resp.query_executions[0].execution_parameters[0] #=> String
    #   resp.query_executions[0].substatement_type #=> String
    #   resp.query_executions[0].query_results_s3_access_grants_configuration.enable_s3_access_grants #=> Boolean
    #   resp.query_executions[0].query_results_s3_access_grants_configuration.create_user_level_prefix #=> Boolean
    #   resp.query_executions[0].query_results_s3_access_grants_configuration.authentication_type #=> String, one of "DIRECTORY_IDENTITY"
    #   resp.unprocessed_query_execution_ids #=> Array
    #   resp.unprocessed_query_execution_ids[0].query_execution_id #=> String
    #   resp.unprocessed_query_execution_ids[0].error_code #=> String
    #   resp.unprocessed_query_execution_ids[0].error_message #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/BatchGetQueryExecution AWS API Documentation
    #
    # @overload batch_get_query_execution(params = {})
    # @param [Hash] params ({})
    def batch_get_query_execution(params = {}, options = {})
      req = build_request(:batch_get_query_execution, params)
      req.send_request(options)
    end

    # Cancels the capacity reservation with the specified name. Cancelled
    # reservations remain in your account and will be deleted 45 days after
    # cancellation. During the 45 days, you cannot re-purpose or reuse a
    # reservation that has been cancelled, but you can refer to its tags and
    # view it for historical reference.
    #
    # @option params [required, String] :name
    #   The name of the capacity reservation to cancel.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.cancel_capacity_reservation({
    #     name: "CapacityReservationName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CancelCapacityReservation AWS API Documentation
    #
    # @overload cancel_capacity_reservation(params = {})
    # @param [Hash] params ({})
    def cancel_capacity_reservation(params = {}, options = {})
      req = build_request(:cancel_capacity_reservation, params)
      req.send_request(options)
    end

    # Creates a capacity reservation with the specified name and number of
    # requested data processing units.
    #
    # @option params [required, Integer] :target_dpus
    #   The number of requested data processing units.
    #
    # @option params [required, String] :name
    #   The name of the capacity reservation to create.
    #
    # @option params [Array<Types::Tag>] :tags
    #   The tags for the capacity reservation.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_capacity_reservation({
    #     target_dpus: 1, # required
    #     name: "CapacityReservationName", # required
    #     tags: [
    #       {
    #         key: "TagKey",
    #         value: "TagValue",
    #       },
    #     ],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateCapacityReservation AWS API Documentation
    #
    # @overload create_capacity_reservation(params = {})
    # @param [Hash] params ({})
    def create_capacity_reservation(params = {}, options = {})
      req = build_request(:create_capacity_reservation, params)
      req.send_request(options)
    end

    # Creates (registers) a data catalog with the specified name and
    # properties. Catalogs created are visible to all users of the same
    # Amazon Web Services account.
    #
    # For a `FEDERATED` catalog, this API operation creates the following
    # resources.
    #
    # * CFN Stack Name with a maximum length of 128 characters and prefix
    #   `athenafederatedcatalog-CATALOG_NAME_SANITIZED` with length 23
    #   characters.
    #
    # * Lambda Function Name with a maximum length of 64 characters and
    #   prefix `athenafederatedcatalog_CATALOG_NAME_SANITIZED` with length
    #   23 characters.
    #
    # * Glue Connection Name with a maximum length of 255 characters and a
    #   prefix `athenafederatedcatalog_CATALOG_NAME_SANITIZED` with length
    #   23 characters.
    #
    # @option params [required, String] :name
    #   The name of the data catalog to create. The catalog name must be
    #   unique for the Amazon Web Services account and can use a maximum of
    #   127 alphanumeric, underscore, at sign, or hyphen characters. The
    #   remainder of the length constraint of 256 is reserved for use by
    #   Athena.
    #
    #   For `FEDERATED` type the catalog name has following considerations and
    #   limits:
    #
    #   * The catalog name allows special characters such as `_ , @ , \ , - `.
    #     These characters are replaced with a hyphen (-) when creating the
    #     CFN Stack Name and with an underscore (\_) when creating the Lambda
    #     Function and Glue Connection Name.
    #
    #   * The catalog name has a theoretical limit of 128 characters. However,
    #     since we use it to create other resources that allow less characters
    #     and we prepend a prefix to it, the actual catalog name limit for
    #     `FEDERATED` catalog is 64 - 23 = 41 characters.
    #
    # @option params [required, String] :type
    #   The type of data catalog to create: `LAMBDA` for a federated catalog,
    #   `GLUE` for an Glue Data Catalog, and `HIVE` for an external Apache
    #   Hive metastore. `FEDERATED` is a federated catalog for which Athena
    #   creates the connection and the Lambda function for you based on the
    #   parameters that you pass.
    #
    #   For `FEDERATED` type, we do not support IAM identity center.
    #
    # @option params [String] :description
    #   A description of the data catalog to be created.
    #
    # @option params [Hash<String,String>] :parameters
    #   Specifies the Lambda function or functions to use for creating the
    #   data catalog. This is a mapping whose values depend on the catalog
    #   type.
    #
    #   * For the `HIVE` data catalog type, use the following syntax. The
    #     `metadata-function` parameter is required. `The sdk-version`
    #     parameter is optional and defaults to the currently supported
    #     version.
    #
    #     `metadata-function=lambda_arn, sdk-version=version_number `
    #
    #   * For the `LAMBDA` data catalog type, use one of the following sets of
    #     required parameters, but not both.
    #
    #     * If you have one Lambda function that processes metadata and
    #       another for reading the actual data, use the following syntax.
    #       Both parameters are required.
    #
    #       `metadata-function=lambda_arn, record-function=lambda_arn `
    #
    #     * If you have a composite Lambda function that processes both
    #       metadata and data, use the following syntax to specify your Lambda
    #       function.
    #
    #       `function=lambda_arn `
    #   * The `GLUE` type takes a catalog ID parameter and is required. The `
    #     catalog_id ` is the account ID of the Amazon Web Services account to
    #     which the Glue Data Catalog belongs.
    #
    #     `catalog-id=catalog_id `
    #
    #     * The `GLUE` data catalog type also applies to the default
    #       `AwsDataCatalog` that already exists in your account, of which you
    #       can have only one and cannot modify.
    #
    #     ^
    #   * The `FEDERATED` data catalog type uses one of the following
    #     parameters, but not both. Use `connection-arn` for an existing Glue
    #     connection. Use `connection-type` and `connection-properties` to
    #     specify the configuration setting for a new connection.
    #
    #     * `connection-arn:<glue_connection_arn_to_reuse> `
    #
    #     * `lambda-role-arn` (optional): The execution role to use for the
    #       Lambda function. If not provided, one is created.
    #
    #     * `connection-type:MYSQL|REDSHIFT|....,
    #       connection-properties:"<json_string>"`
    #
    #       For <i> <code>&lt;json_string&gt;</code> </i>, use escaped JSON
    #       text, as in the following example.
    #
    #       `"{"spill_bucket":"my_spill","spill_prefix":"athena-spill","host":"abc12345.snowflakecomputing.com","port":"1234","warehouse":"DEV_WH","database":"TEST","schema":"PUBLIC","SecretArn":"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j"}"`
    #
    # @option params [Array<Types::Tag>] :tags
    #   A list of comma separated tags to add to the data catalog that is
    #   created. All the resources that are created by the `CreateDataCatalog`
    #   API operation with `FEDERATED` type will have the tag
    #   `federated_athena_datacatalog="true"`. This includes the CFN Stack,
    #   Glue Connection, Athena DataCatalog, and all the resources created as
    #   part of the CFN Stack (Lambda Function, IAM policies/roles).
    #
    # @return [Types::CreateDataCatalogOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateDataCatalogOutput#data_catalog #data_catalog} => Types::DataCatalog
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_data_catalog({
    #     name: "CatalogNameString", # required
    #     type: "LAMBDA", # required, accepts LAMBDA, GLUE, HIVE, FEDERATED
    #     description: "DescriptionString",
    #     parameters: {
    #       "KeyString" => "ParametersMapValue",
    #     },
    #     tags: [
    #       {
    #         key: "TagKey",
    #         value: "TagValue",
    #       },
    #     ],
    #   })
    #
    # @example Response structure
    #
    #   resp.data_catalog.name #=> String
    #   resp.data_catalog.description #=> String
    #   resp.data_catalog.type #=> String, one of "LAMBDA", "GLUE", "HIVE", "FEDERATED"
    #   resp.data_catalog.parameters #=> Hash
    #   resp.data_catalog.parameters["KeyString"] #=> String
    #   resp.data_catalog.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
    #   resp.data_catalog.connection_type #=> String, one of "DYNAMODB", "MYSQL", "POSTGRESQL", "REDSHIFT", "ORACLE", "SYNAPSE", "SQLSERVER", "DB2", "OPENSEARCH", "BIGQUERY", "GOOGLECLOUDSTORAGE", "HBASE", "DOCUMENTDB", "CMDB", "TPCDS", "TIMESTREAM", "SAPHANA", "SNOWFLAKE", "DATALAKEGEN2", "DB2AS400"
    #   resp.data_catalog.error #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateDataCatalog AWS API Documentation
    #
    # @overload create_data_catalog(params = {})
    # @param [Hash] params ({})
    def create_data_catalog(params = {}, options = {})
      req = build_request(:create_data_catalog, params)
      req.send_request(options)
    end

    # Creates a named query in the specified workgroup. Requires that you
    # have access to the workgroup.
    #
    # @option params [required, String] :name
    #   The query name.
    #
    # @option params [String] :description
    #   The query description.
    #
    # @option params [required, String] :database
    #   The database to which the query belongs.
    #
    # @option params [required, String] :query_string
    #   The contents of the query with all query statements.
    #
    # @option params [String] :client_request_token
    #   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.**
    #
    # @option params [String] :work_group
    #   The name of the workgroup in which the named query is being created.
    #
    # @return [Types::CreateNamedQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateNamedQueryOutput#named_query_id #named_query_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_named_query({
    #     name: "NameString", # required
    #     description: "DescriptionString",
    #     database: "DatabaseString", # required
    #     query_string: "QueryString", # required
    #     client_request_token: "IdempotencyToken",
    #     work_group: "WorkGroupName",
    #   })
    #
    # @example Response structure
    #
    #   resp.named_query_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNamedQuery AWS API Documentation
    #
    # @overload create_named_query(params = {})
    # @param [Hash] params ({})
    def create_named_query(params = {}, options = {})
      req = build_request(:create_named_query, params)
      req.send_request(options)
    end

    # Creates an empty `ipynb` file in the specified Apache Spark enabled
    # workgroup. Throws an error if a file in the workgroup with the same
    # name already exists.
    #
    # @option params [required, String] :work_group
    #   The name of the Spark enabled workgroup in which the notebook will be
    #   created.
    #
    # @option params [required, String] :name
    #   The name of the `ipynb` file to be created in the Spark workgroup,
    #   without the `.ipynb` extension.
    #
    # @option params [String] :client_request_token
    #   A unique case-sensitive string used to ensure the request to create
    #   the notebook is idempotent (executes only once).
    #
    #   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 you. 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.
    #
    # @return [Types::CreateNotebookOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateNotebookOutput#notebook_id #notebook_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_notebook({
    #     work_group: "WorkGroupName", # required
    #     name: "NotebookName", # required
    #     client_request_token: "ClientRequestToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.notebook_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNotebook AWS API Documentation
    #
    # @overload create_notebook(params = {})
    # @param [Hash] params ({})
    def create_notebook(params = {}, options = {})
      req = build_request(:create_notebook, params)
      req.send_request(options)
    end

    # Creates a prepared statement for use with SQL queries in Athena.
    #
    # @option params [required, String] :statement_name
    #   The name of the prepared statement.
    #
    # @option params [required, String] :work_group
    #   The name of the workgroup to which the prepared statement belongs.
    #
    # @option params [required, String] :query_statement
    #   The query string for the prepared statement.
    #
    # @option params [String] :description
    #   The description of the prepared statement.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_prepared_statement({
    #     statement_name: "StatementName", # required
    #     work_group: "WorkGroupName", # required
    #     query_statement: "QueryString", # required
    #     description: "DescriptionString",
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreatePreparedStatement AWS API Documentation
    #
    # @overload create_prepared_statement(params = {})
    # @param [Hash] params ({})
    def create_prepared_statement(params = {}, options = {})
      req = build_request(:create_prepared_statement, params)
      req.send_request(options)
    end

    # Gets an authentication token and the URL at which the notebook can be
    # accessed. During programmatic access, `CreatePresignedNotebookUrl`
    # must be called every 10 minutes to refresh the authentication token.
    # For information about granting programmatic access, see [Grant
    # programmatic access][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access
    #
    # @option params [required, String] :session_id
    #   The session ID.
    #
    # @return [Types::CreatePresignedNotebookUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreatePresignedNotebookUrlResponse#notebook_url #notebook_url} => String
    #   * {Types::CreatePresignedNotebookUrlResponse#auth_token #auth_token} => String
    #   * {Types::CreatePresignedNotebookUrlResponse#auth_token_expiration_time #auth_token_expiration_time} => Integer
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_presigned_notebook_url({
    #     session_id: "SessionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.notebook_url #=> String
    #   resp.auth_token #=> String
    #   resp.auth_token_expiration_time #=> Integer
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreatePresignedNotebookUrl AWS API Documentation
    #
    # @overload create_presigned_notebook_url(params = {})
    # @param [Hash] params ({})
    def create_presigned_notebook_url(params = {}, options = {})
      req = build_request(:create_presigned_notebook_url, params)
      req.send_request(options)
    end

    # Creates a workgroup with the specified name. A workgroup can be an
    # Apache Spark enabled workgroup or an Athena SQL workgroup.
    #
    # @option params [required, String] :name
    #   The workgroup name.
    #
    # @option params [Types::WorkGroupConfiguration] :configuration
    #   Contains configuration information for creating an Athena SQL
    #   workgroup or Spark enabled Athena workgroup. Athena SQL workgroup
    #   configuration includes the location in Amazon S3 where query and
    #   calculation results are stored, the encryption configuration, if any,
    #   used for encrypting query results, whether the Amazon CloudWatch
    #   Metrics are enabled for the workgroup, the limit for the amount of
    #   bytes scanned (cutoff) per query, if it is specified, and whether
    #   workgroup's settings (specified with `EnforceWorkGroupConfiguration`)
    #   in the `WorkGroupConfiguration` override client-side settings. See
    #   WorkGroupConfiguration$EnforceWorkGroupConfiguration.
    #
    # @option params [String] :description
    #   The workgroup description.
    #
    # @option params [Array<Types::Tag>] :tags
    #   A list of comma separated tags to add to the workgroup that is
    #   created.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_work_group({
    #     name: "WorkGroupName", # required
    #     configuration: {
    #       result_configuration: {
    #         output_location: "ResultOutputLocation",
    #         encryption_configuration: {
    #           encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
    #           kms_key: "String",
    #         },
    #         expected_bucket_owner: "AwsAccountId",
    #         acl_configuration: {
    #           s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
    #         },
    #       },
    #       managed_query_results_configuration: {
    #         enabled: false, # required
    #         encryption_configuration: {
    #           kms_key: "KmsKey", # required
    #         },
    #       },
    #       enforce_work_group_configuration: false,
    #       publish_cloud_watch_metrics_enabled: false,
    #       bytes_scanned_cutoff_per_query: 1,
    #       requester_pays_enabled: false,
    #       engine_version: {
    #         selected_engine_version: "NameString",
    #         effective_engine_version: "NameString",
    #       },
    #       additional_configuration: "NameString",
    #       execution_role: "RoleArn",
    #       customer_content_encryption_configuration: {
    #         kms_key: "KmsKey", # required
    #       },
    #       enable_minimum_encryption_configuration: false,
    #       identity_center_configuration: {
    #         enable_identity_center: false,
    #         identity_center_instance_arn: "IdentityCenterInstanceArn",
    #       },
    #       query_results_s3_access_grants_configuration: {
    #         enable_s3_access_grants: false, # required
    #         create_user_level_prefix: false,
    #         authentication_type: "DIRECTORY_IDENTITY", # required, accepts DIRECTORY_IDENTITY
    #       },
    #     },
    #     description: "WorkGroupDescriptionString",
    #     tags: [
    #       {
    #         key: "TagKey",
    #         value: "TagValue",
    #       },
    #     ],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateWorkGroup AWS API Documentation
    #
    # @overload create_work_group(params = {})
    # @param [Hash] params ({})
    def create_work_group(params = {}, options = {})
      req = build_request(:create_work_group, params)
      req.send_request(options)
    end

    # Deletes a cancelled capacity reservation. A reservation must be
    # cancelled before it can be deleted. A deleted reservation is
    # immediately removed from your account and can no longer be referenced,
    # including by its ARN. A deleted reservation cannot be called by
    # `GetCapacityReservation`, and deleted reservations do not appear in
    # the output of `ListCapacityReservations`.
    #
    # @option params [required, String] :name
    #   The name of the capacity reservation to delete.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_capacity_reservation({
    #     name: "CapacityReservationName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteCapacityReservation AWS API Documentation
    #
    # @overload delete_capacity_reservation(params = {})
    # @param [Hash] params ({})
    def delete_capacity_reservation(params = {}, options = {})
      req = build_request(:delete_capacity_reservation, params)
      req.send_request(options)
    end

    # Deletes a data catalog.
    #
    # @option params [required, String] :name
    #   The name of the data catalog to delete.
    #
    # @option params [Boolean] :delete_catalog_only
    #   Deletes the Athena Data Catalog. You can only use this with the
    #   `FEDERATED` catalogs. You usually perform this before registering the
    #   connector with Glue Data Catalog. After deletion, you will have to
    #   manage the Glue Connection and Lambda function.
    #
    # @return [Types::DeleteDataCatalogOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DeleteDataCatalogOutput#data_catalog #data_catalog} => Types::DataCatalog
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_data_catalog({
    #     name: "CatalogNameString", # required
    #     delete_catalog_only: false,
    #   })
    #
    # @example Response structure
    #
    #   resp.data_catalog.name #=> String
    #   resp.data_catalog.description #=> String
    #   resp.data_catalog.type #=> String, one of "LAMBDA", "GLUE", "HIVE", "FEDERATED"
    #   resp.data_catalog.parameters #=> Hash
    #   resp.data_catalog.parameters["KeyString"] #=> String
    #   resp.data_catalog.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
    #   resp.data_catalog.connection_type #=> String, one of "DYNAMODB", "MYSQL", "POSTGRESQL", "REDSHIFT", "ORACLE", "SYNAPSE", "SQLSERVER", "DB2", "OPENSEARCH", "BIGQUERY", "GOOGLECLOUDSTORAGE", "HBASE", "DOCUMENTDB", "CMDB", "TPCDS", "TIMESTREAM", "SAPHANA", "SNOWFLAKE", "DATALAKEGEN2", "DB2AS400"
    #   resp.data_catalog.error #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteDataCatalog AWS API Documentation
    #
    # @overload delete_data_catalog(params = {})
    # @param [Hash] params ({})
    def delete_data_catalog(params = {}, options = {})
      req = build_request(:delete_data_catalog, params)
      req.send_request(options)
    end

    # Deletes the named query if you have access to the workgroup in which
    # the query was saved.
    #
    # @option params [required, String] :named_query_id
    #   The unique ID of the query to delete.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_named_query({
    #     named_query_id: "NamedQueryId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteNamedQuery AWS API Documentation
    #
    # @overload delete_named_query(params = {})
    # @param [Hash] params ({})
    def delete_named_query(params = {}, options = {})
      req = build_request(:delete_named_query, params)
      req.send_request(options)
    end

    # Deletes the specified notebook.
    #
    # @option params [required, String] :notebook_id
    #   The ID of the notebook to delete.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_notebook({
    #     notebook_id: "NotebookId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteNotebook AWS API Documentation
    #
    # @overload delete_notebook(params = {})
    # @param [Hash] params ({})
    def delete_notebook(params = {}, options = {})
      req = build_request(:delete_notebook, params)
      req.send_request(options)
    end

    # Deletes the prepared statement with the specified name from the
    # specified workgroup.
    #
    # @option params [required, String] :statement_name
    #   The name of the prepared statement to delete.
    #
    # @option params [required, String] :work_group
    #   The workgroup to which the statement to be deleted belongs.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_prepared_statement({
    #     statement_name: "StatementName", # required
    #     work_group: "WorkGroupName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeletePreparedStatement AWS API Documentation
    #
    # @overload delete_prepared_statement(params = {})
    # @param [Hash] params ({})
    def delete_prepared_statement(params = {}, options = {})
      req = build_request(:delete_prepared_statement, params)
      req.send_request(options)
    end

    # Deletes the workgroup with the specified name. The primary workgroup
    # cannot be deleted.
    #
    # @option params [required, String] :work_group
    #   The unique name of the workgroup to delete.
    #
    # @option params [Boolean] :recursive_delete_option
    #   The option to delete the workgroup and its contents even if the
    #   workgroup contains any named queries, query executions, or notebooks.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_work_group({
    #     work_group: "WorkGroupName", # required
    #     recursive_delete_option: false,
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/DeleteWorkGroup AWS API Documentation
    #
    # @overload delete_work_group(params = {})
    # @param [Hash] params ({})
    def delete_work_group(params = {}, options = {})
      req = build_request(:delete_work_group, params)
      req.send_request(options)
    end

    # Exports the specified notebook and its metadata.
    #
    # @option params [required, String] :notebook_id
    #   The ID of the notebook to export.
    #
    # @return [Types::ExportNotebookOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ExportNotebookOutput#notebook_metadata #notebook_metadata} => Types::NotebookMetadata
    #   * {Types::ExportNotebookOutput#payload #payload} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.export_notebook({
    #     notebook_id: "NotebookId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.notebook_metadata.notebook_id #=> String
    #   resp.notebook_metadata.name #=> String
    #   resp.notebook_metadata.work_group #=> String
    #   resp.notebook_metadata.creation_time #=> Time
    #   resp.notebook_metadata.type #=> String, one of "IPYNB"
    #   resp.notebook_metadata.last_modified_time #=> Time
    #   resp.payload #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ExportNotebook AWS API Documentation
    #
    # @overload export_notebook(params = {})
    # @param [Hash] params ({})
    def export_notebook(params = {}, options = {})
      req = build_request(:export_notebook, params)
      req.send_request(options)
    end

    # Describes a previously submitted calculation execution.
    #
    # @option params [required, String] :calculation_execution_id
    #   The calculation execution UUID.
    #
    # @return [Types::GetCalculationExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetCalculationExecutionResponse#calculation_execution_id #calculation_execution_id} => String
    #   * {Types::GetCalculationExecutionResponse#session_id #session_id} => String
    #   * {Types::GetCalculationExecutionResponse#description #description} => String
    #   * {Types::GetCalculationExecutionResponse#working_directory #working_directory} => String
    #   * {Types::GetCalculationExecutionResponse#status #status} => Types::CalculationStatus
    #   * {Types::GetCalculationExecutionResponse#statistics #statistics} => Types::CalculationStatistics
    #   * {Types::GetCalculationExecutionResponse#result #result} => Types::CalculationResult
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_calculation_execution({
    #     calculation_execution_id: "CalculationExecutionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.calculation_execution_id #=> String
    #   resp.session_id #=> String
    #   resp.description #=> String
    #   resp.working_directory #=> String
    #   resp.status.submission_date_time #=> Time
    #   resp.status.completion_date_time #=> Time
    #   resp.status.state #=> String, one of "CREATING", "CREATED", "QUEUED", "RUNNING", "CANCELING", "CANCELED", "COMPLETED", "FAILED"
    #   resp.status.state_change_reason #=> String
    #   resp.statistics.dpu_execution_in_millis #=> Integer
    #   resp.statistics.progress #=> String
    #   resp.result.std_out_s3_uri #=> String
    #   resp.result.std_error_s3_uri #=> String
    #   resp.result.result_s3_uri #=> String
    #   resp.result.result_type #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecution AWS API Documentation
    #
    # @overload get_calculation_execution(params = {})
    # @param [Hash] params ({})
    def get_calculation_execution(params = {}, options = {})
      req = build_request(:get_calculation_execution, params)
      req.send_request(options)
    end

    # Retrieves the unencrypted code that was executed for the calculation.
    #
    # @option params [required, String] :calculation_execution_id
    #   The calculation execution UUID.
    #
    # @return [Types::GetCalculationExecutionCodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetCalculationExecutionCodeResponse#code_block #code_block} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_calculation_execution_code({
    #     calculation_execution_id: "CalculationExecutionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.code_block #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecutionCode AWS API Documentation
    #
    # @overload get_calculation_execution_code(params = {})
    # @param [Hash] params ({})
    def get_calculation_execution_code(params = {}, options = {})
      req = build_request(:get_calculation_execution_code, params)
      req.send_request(options)
    end

    # Gets the status of a current calculation.
    #
    # @option params [required, String] :calculation_execution_id
    #   The calculation execution UUID.
    #
    # @return [Types::GetCalculationExecutionStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetCalculationExecutionStatusResponse#status #status} => Types::CalculationStatus
    #   * {Types::GetCalculationExecutionStatusResponse#statistics #statistics} => Types::CalculationStatistics
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_calculation_execution_status({
    #     calculation_execution_id: "CalculationExecutionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.status.submission_date_time #=> Time
    #   resp.status.completion_date_time #=> Time
    #   resp.status.state #=> String, one of "CREATING", "CREATED", "QUEUED", "RUNNING", "CANCELING", "CANCELED", "COMPLETED", "FAILED"
    #   resp.status.state_change_reason #=> String
    #   resp.statistics.dpu_execution_in_millis #=> Integer
    #   resp.statistics.progress #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCalculationExecutionStatus AWS API Documentation
    #
    # @overload get_calculation_execution_status(params = {})
    # @param [Hash] params ({})
    def get_calculation_execution_status(params = {}, options = {})
      req = build_request(:get_calculation_execution_status, params)
      req.send_request(options)
    end

    # Gets the capacity assignment configuration for a capacity reservation,
    # if one exists.
    #
    # @option params [required, String] :capacity_reservation_name
    #   The name of the capacity reservation to retrieve the capacity
    #   assignment configuration for.
    #
    # @return [Types::GetCapacityAssignmentConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetCapacityAssignmentConfigurationOutput#capacity_assignment_configuration #capacity_assignment_configuration} => Types::CapacityAssignmentConfiguration
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_capacity_assignment_configuration({
    #     capacity_reservation_name: "CapacityReservationName", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.capacity_assignment_configuration.capacity_reservation_name #=> String
    #   resp.capacity_assignment_configuration.capacity_assignments #=> Array
    #   resp.capacity_assignment_configuration.capacity_assignments[0].work_group_names #=> Array
    #   resp.capacity_assignment_configuration.capacity_assignments[0].work_group_names[0] #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCapacityAssignmentConfiguration AWS API Documentation
    #
    # @overload get_capacity_assignment_configuration(params = {})
    # @param [Hash] params ({})
    def get_capacity_assignment_configuration(params = {}, options = {})
      req = build_request(:get_capacity_assignment_configuration, params)
      req.send_request(options)
    end

    # Returns information about the capacity reservation with the specified
    # name.
    #
    # @option params [required, String] :name
    #   The name of the capacity reservation.
    #
    # @return [Types::GetCapacityReservationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetCapacityReservationOutput#capacity_reservation #capacity_reservation} => Types::CapacityReservation
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_capacity_reservation({
    #     name: "CapacityReservationName", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.capacity_reservation.name #=> String
    #   resp.capacity_reservation.status #=> String, one of "PENDING", "ACTIVE", "CANCELLING", "CANCELLED", "FAILED", "UPDATE_PENDING"
    #   resp.capacity_reservation.target_dpus #=> Integer
    #   resp.capacity_reservation.allocated_dpus #=> Integer
    #   resp.capacity_reservation.last_allocation.status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
    #   resp.capacity_reservation.last_allocation.status_message #=> String
    #   resp.capacity_reservation.last_allocation.request_time #=> Time
    #   resp.capacity_reservation.last_allocation.request_completion_time #=> Time
    #   resp.capacity_reservation.last_successful_allocation_time #=> Time
    #   resp.capacity_reservation.creation_time #=> Time
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetCapacityReservation AWS API Documentation
    #
    # @overload get_capacity_reservation(params = {})
    # @param [Hash] params ({})
    def get_capacity_reservation(params = {}, options = {})
      req = build_request(:get_capacity_reservation, params)
      req.send_request(options)
    end

    # Returns the specified data catalog.
    #
    # @option params [required, String] :name
    #   The name of the data catalog to return.
    #
    # @option params [String] :work_group
    #   The name of the workgroup. Required if making an IAM Identity Center
    #   request.
    #
    # @return [Types::GetDataCatalogOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetDataCatalogOutput#data_catalog #data_catalog} => Types::DataCatalog
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_data_catalog({
    #     name: "CatalogNameString", # required
    #     work_group: "WorkGroupName",
    #   })
    #
    # @example Response structure
    #
    #   resp.data_catalog.name #=> String
    #   resp.data_catalog.description #=> String
    #   resp.data_catalog.type #=> String, one of "LAMBDA", "GLUE", "HIVE", "FEDERATED"
    #   resp.data_catalog.parameters #=> Hash
    #   resp.data_catalog.parameters["KeyString"] #=> String
    #   resp.data_catalog.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
    #   resp.data_catalog.connection_type #=> String, one of "DYNAMODB", "MYSQL", "POSTGRESQL", "REDSHIFT", "ORACLE", "SYNAPSE", "SQLSERVER", "DB2", "OPENSEARCH", "BIGQUERY", "GOOGLECLOUDSTORAGE", "HBASE", "DOCUMENTDB", "CMDB", "TPCDS", "TIMESTREAM", "SAPHANA", "SNOWFLAKE", "DATALAKEGEN2", "DB2AS400"
    #   resp.data_catalog.error #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDataCatalog AWS API Documentation
    #
    # @overload get_data_catalog(params = {})
    # @param [Hash] params ({})
    def get_data_catalog(params = {}, options = {})
      req = build_request(:get_data_catalog, params)
      req.send_request(options)
    end

    # Returns a database object for the specified database and data catalog.
    #
    # @option params [required, String] :catalog_name
    #   The name of the data catalog that contains the database to return.
    #
    # @option params [required, String] :database_name
    #   The name of the database to return.
    #
    # @option params [String] :work_group
    #   The name of the workgroup for which the metadata is being fetched.
    #   Required if requesting an IAM Identity Center enabled Glue Data
    #   Catalog.
    #
    # @return [Types::GetDatabaseOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetDatabaseOutput#database #database} => Types::Database
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_database({
    #     catalog_name: "CatalogNameString", # required
    #     database_name: "NameString", # required
    #     work_group: "WorkGroupName",
    #   })
    #
    # @example Response structure
    #
    #   resp.database.name #=> String
    #   resp.database.description #=> String
    #   resp.database.parameters #=> Hash
    #   resp.database.parameters["KeyString"] #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetDatabase AWS API Documentation
    #
    # @overload get_database(params = {})
    # @param [Hash] params ({})
    def get_database(params = {}, options = {})
      req = build_request(:get_database, params)
      req.send_request(options)
    end

    # Returns information about a single query. Requires that you have
    # access to the workgroup in which the query was saved.
    #
    # @option params [required, String] :named_query_id
    #   The unique ID of the query. Use ListNamedQueries to get query IDs.
    #
    # @return [Types::GetNamedQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetNamedQueryOutput#named_query #named_query} => Types::NamedQuery
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_named_query({
    #     named_query_id: "NamedQueryId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.named_query.name #=> String
    #   resp.named_query.description #=> String
    #   resp.named_query.database #=> String
    #   resp.named_query.query_string #=> String
    #   resp.named_query.named_query_id #=> String
    #   resp.named_query.work_group #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNamedQuery AWS API Documentation
    #
    # @overload get_named_query(params = {})
    # @param [Hash] params ({})
    def get_named_query(params = {}, options = {})
      req = build_request(:get_named_query, params)
      req.send_request(options)
    end

    # Retrieves notebook metadata for the specified notebook ID.
    #
    # @option params [required, String] :notebook_id
    #   The ID of the notebook whose metadata is to be retrieved.
    #
    # @return [Types::GetNotebookMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetNotebookMetadataOutput#notebook_metadata #notebook_metadata} => Types::NotebookMetadata
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_notebook_metadata({
    #     notebook_id: "NotebookId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.notebook_metadata.notebook_id #=> String
    #   resp.notebook_metadata.name #=> String
    #   resp.notebook_metadata.work_group #=> String
    #   resp.notebook_metadata.creation_time #=> Time
    #   resp.notebook_metadata.type #=> String, one of "IPYNB"
    #   resp.notebook_metadata.last_modified_time #=> Time
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetNotebookMetadata AWS API Documentation
    #
    # @overload get_notebook_metadata(params = {})
    # @param [Hash] params ({})
    def get_notebook_metadata(params = {}, options = {})
      req = build_request(:get_notebook_metadata, params)
      req.send_request(options)
    end

    # Retrieves the prepared statement with the specified name from the
    # specified workgroup.
    #
    # @option params [required, String] :statement_name
    #   The name of the prepared statement to retrieve.
    #
    # @option params [required, String] :work_group
    #   The workgroup to which the statement to be retrieved belongs.
    #
    # @return [Types::GetPreparedStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetPreparedStatementOutput#prepared_statement #prepared_statement} => Types::PreparedStatement
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_prepared_statement({
    #     statement_name: "StatementName", # required
    #     work_group: "WorkGroupName", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.prepared_statement.statement_name #=> String
    #   resp.prepared_statement.query_statement #=> String
    #   resp.prepared_statement.work_group_name #=> String
    #   resp.prepared_statement.description #=> String
    #   resp.prepared_statement.last_modified_time #=> Time
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetPreparedStatement AWS API Documentation
    #
    # @overload get_prepared_statement(params = {})
    # @param [Hash] params ({})
    def get_prepared_statement(params = {}, options = {})
      req = build_request(:get_prepared_statement, params)
      req.send_request(options)
    end

    # Returns information about a single execution of a query if you have
    # access to the workgroup in which the query ran. Each time a query
    # executes, information about the query execution is saved with a unique
    # ID.
    #
    # @option params [required, String] :query_execution_id
    #   The unique ID of the query execution.
    #
    # @return [Types::GetQueryExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetQueryExecutionOutput#query_execution #query_execution} => Types::QueryExecution
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_query_execution({
    #     query_execution_id: "QueryExecutionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.query_execution.query_execution_id #=> String
    #   resp.query_execution.query #=> String
    #   resp.query_execution.statement_type #=> String, one of "DDL", "DML", "UTILITY"
    #   resp.query_execution.managed_query_results_configuration.enabled #=> Boolean
    #   resp.query_execution.managed_query_results_configuration.encryption_configuration.kms_key #=> String
    #   resp.query_execution.result_configuration.output_location #=> String
    #   resp.query_execution.result_configuration.encryption_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS", "CSE_KMS"
    #   resp.query_execution.result_configuration.encryption_configuration.kms_key #=> String
    #   resp.query_execution.result_configuration.expected_bucket_owner #=> String
    #   resp.query_execution.result_configuration.acl_configuration.s3_acl_option #=> String, one of "BUCKET_OWNER_FULL_CONTROL"
    #   resp.query_execution.result_reuse_configuration.result_reuse_by_age_configuration.enabled #=> Boolean
    #   resp.query_execution.result_reuse_configuration.result_reuse_by_age_configuration.max_age_in_minutes #=> Integer
    #   resp.query_execution.query_execution_context.database #=> String
    #   resp.query_execution.query_execution_context.catalog #=> String
    #   resp.query_execution.status.state #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED"
    #   resp.query_execution.status.state_change_reason #=> String
    #   resp.query_execution.status.submission_date_time #=> Time
    #   resp.query_execution.status.completion_date_time #=> Time
    #   resp.query_execution.status.athena_error.error_category #=> Integer
    #   resp.query_execution.status.athena_error.error_type #=> Integer
    #   resp.query_execution.status.athena_error.retryable #=> Boolean
    #   resp.query_execution.status.athena_error.error_message #=> String
    #   resp.query_execution.statistics.engine_execution_time_in_millis #=> Integer
    #   resp.query_execution.statistics.data_scanned_in_bytes #=> Integer
    #   resp.query_execution.statistics.data_manifest_location #=> String
    #   resp.query_execution.statistics.total_execution_time_in_millis #=> Integer
    #   resp.query_execution.statistics.query_queue_time_in_millis #=> Integer
    #   resp.query_execution.statistics.service_pre_processing_time_in_millis #=> Integer
    #   resp.query_execution.statistics.query_planning_time_in_millis #=> Integer
    #   resp.query_execution.statistics.service_processing_time_in_millis #=> Integer
    #   resp.query_execution.statistics.result_reuse_information.reused_previous_result #=> Boolean
    #   resp.query_execution.work_group #=> String
    #   resp.query_execution.engine_version.selected_engine_version #=> String
    #   resp.query_execution.engine_version.effective_engine_version #=> String
    #   resp.query_execution.execution_parameters #=> Array
    #   resp.query_execution.execution_parameters[0] #=> String
    #   resp.query_execution.substatement_type #=> String
    #   resp.query_execution.query_results_s3_access_grants_configuration.enable_s3_access_grants #=> Boolean
    #   resp.query_execution.query_results_s3_access_grants_configuration.create_user_level_prefix #=> Boolean
    #   resp.query_execution.query_results_s3_access_grants_configuration.authentication_type #=> String, one of "DIRECTORY_IDENTITY"
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryExecution AWS API Documentation
    #
    # @overload get_query_execution(params = {})
    # @param [Hash] params ({})
    def get_query_execution(params = {}, options = {})
      req = build_request(:get_query_execution, params)
      req.send_request(options)
    end

    # Streams the results of a single query execution specified by
    # `QueryExecutionId` from the Athena query results location in Amazon
    # S3. For more information, see [Working with query results, recent
    # queries, and output files][1] in the *Amazon Athena User Guide*. This
    # request does not execute the query but returns results. Use
    # StartQueryExecution to run a query.
    #
    # To stream query results successfully, the IAM principal with
    # permission to call `GetQueryResults` also must have permissions to the
    # Amazon S3 `GetObject` action for the Athena query results location.
    #
    # IAM principals with permission to the Amazon S3 `GetObject` action for
    # the query results location are able to retrieve query results from
    # Amazon S3 even if permission to the `GetQueryResults` action is
    # denied. To restrict user or role access, ensure that Amazon S3
    # permissions to the Athena query location are denied.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/athena/latest/ug/querying.html
    #
    # @option params [required, String] :query_execution_id
    #   The unique ID of the query execution.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results (rows) to return in this request.
    #
    # @option params [String] :query_result_type
    #   When you set this to `DATA_ROWS` or empty, `GetQueryResults` returns
    #   the query results in rows. If set to `DATA_MANIFEST`, it returns the
    #   manifest file in rows. Only the query types `CREATE TABLE AS SELECT`,
    #   `UNLOAD`, and `INSERT` can generate a manifest file. If you use
    #   `DATA_MANIFEST` for other query types, the query will fail.
    #
    # @return [Types::GetQueryResultsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetQueryResultsOutput#update_count #update_count} => Integer
    #   * {Types::GetQueryResultsOutput#result_set #result_set} => Types::ResultSet
    #   * {Types::GetQueryResultsOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_query_results({
    #     query_execution_id: "QueryExecutionId", # required
    #     next_token: "Token",
    #     max_results: 1,
    #     query_result_type: "DATA_MANIFEST", # accepts DATA_MANIFEST, DATA_ROWS
    #   })
    #
    # @example Response structure
    #
    #   resp.update_count #=> Integer
    #   resp.result_set.rows #=> Array
    #   resp.result_set.rows[0].data #=> Array
    #   resp.result_set.rows[0].data[0].var_char_value #=> String
    #   resp.result_set.result_set_metadata.column_info #=> Array
    #   resp.result_set.result_set_metadata.column_info[0].catalog_name #=> String
    #   resp.result_set.result_set_metadata.column_info[0].schema_name #=> String
    #   resp.result_set.result_set_metadata.column_info[0].table_name #=> String
    #   resp.result_set.result_set_metadata.column_info[0].name #=> String
    #   resp.result_set.result_set_metadata.column_info[0].label #=> String
    #   resp.result_set.result_set_metadata.column_info[0].type #=> String
    #   resp.result_set.result_set_metadata.column_info[0].precision #=> Integer
    #   resp.result_set.result_set_metadata.column_info[0].scale #=> Integer
    #   resp.result_set.result_set_metadata.column_info[0].nullable #=> String, one of "NOT_NULL", "NULLABLE", "UNKNOWN"
    #   resp.result_set.result_set_metadata.column_info[0].case_sensitive #=> Boolean
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryResults AWS API Documentation
    #
    # @overload get_query_results(params = {})
    # @param [Hash] params ({})
    def get_query_results(params = {}, options = {})
      req = build_request(:get_query_results, params)
      req.send_request(options)
    end

    # Returns query execution runtime statistics related to a single
    # execution of a query if you have access to the workgroup in which the
    # query ran. Statistics from the `Timeline` section of the response
    # object are available as soon as QueryExecutionStatus$State is in a
    # SUCCEEDED or FAILED state. The remaining non-timeline statistics in
    # the response (like stage-level input and output row count and data
    # size) are updated asynchronously and may not be available immediately
    # after a query completes. The non-timeline statistics are also not
    # included when a query has row-level filters defined in Lake Formation.
    #
    # @option params [required, String] :query_execution_id
    #   The unique ID of the query execution.
    #
    # @return [Types::GetQueryRuntimeStatisticsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetQueryRuntimeStatisticsOutput#query_runtime_statistics #query_runtime_statistics} => Types::QueryRuntimeStatistics
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_query_runtime_statistics({
    #     query_execution_id: "QueryExecutionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.query_runtime_statistics.timeline.query_queue_time_in_millis #=> Integer
    #   resp.query_runtime_statistics.timeline.service_pre_processing_time_in_millis #=> Integer
    #   resp.query_runtime_statistics.timeline.query_planning_time_in_millis #=> Integer
    #   resp.query_runtime_statistics.timeline.engine_execution_time_in_millis #=> Integer
    #   resp.query_runtime_statistics.timeline.service_processing_time_in_millis #=> Integer
    #   resp.query_runtime_statistics.timeline.total_execution_time_in_millis #=> Integer
    #   resp.query_runtime_statistics.rows.input_rows #=> Integer
    #   resp.query_runtime_statistics.rows.input_bytes #=> Integer
    #   resp.query_runtime_statistics.rows.output_bytes #=> Integer
    #   resp.query_runtime_statistics.rows.output_rows #=> Integer
    #   resp.query_runtime_statistics.output_stage.stage_id #=> Integer
    #   resp.query_runtime_statistics.output_stage.state #=> String
    #   resp.query_runtime_statistics.output_stage.output_bytes #=> Integer
    #   resp.query_runtime_statistics.output_stage.output_rows #=> Integer
    #   resp.query_runtime_statistics.output_stage.input_bytes #=> Integer
    #   resp.query_runtime_statistics.output_stage.input_rows #=> Integer
    #   resp.query_runtime_statistics.output_stage.execution_time #=> Integer
    #   resp.query_runtime_statistics.output_stage.query_stage_plan.name #=> String
    #   resp.query_runtime_statistics.output_stage.query_stage_plan.identifier #=> String
    #   resp.query_runtime_statistics.output_stage.query_stage_plan.children #=> Array
    #   resp.query_runtime_statistics.output_stage.query_stage_plan.children[0] #=> Types::QueryStagePlanNode
    #   resp.query_runtime_statistics.output_stage.query_stage_plan.remote_sources #=> Array
    #   resp.query_runtime_statistics.output_stage.query_stage_plan.remote_sources[0] #=> String
    #   resp.query_runtime_statistics.output_stage.sub_stages #=> Array
    #   resp.query_runtime_statistics.output_stage.sub_stages[0] #=> Types::QueryStage
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryRuntimeStatistics AWS API Documentation
    #
    # @overload get_query_runtime_statistics(params = {})
    # @param [Hash] params ({})
    def get_query_runtime_statistics(params = {}, options = {})
      req = build_request(:get_query_runtime_statistics, params)
      req.send_request(options)
    end

    # Gets the full details of a previously created session, including the
    # session status and configuration.
    #
    # @option params [required, String] :session_id
    #   The session ID.
    #
    # @return [Types::GetSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetSessionResponse#session_id #session_id} => String
    #   * {Types::GetSessionResponse#description #description} => String
    #   * {Types::GetSessionResponse#work_group #work_group} => String
    #   * {Types::GetSessionResponse#engine_version #engine_version} => String
    #   * {Types::GetSessionResponse#engine_configuration #engine_configuration} => Types::EngineConfiguration
    #   * {Types::GetSessionResponse#notebook_version #notebook_version} => String
    #   * {Types::GetSessionResponse#session_configuration #session_configuration} => Types::SessionConfiguration
    #   * {Types::GetSessionResponse#status #status} => Types::SessionStatus
    #   * {Types::GetSessionResponse#statistics #statistics} => Types::SessionStatistics
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_session({
    #     session_id: "SessionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.session_id #=> String
    #   resp.description #=> String
    #   resp.work_group #=> String
    #   resp.engine_version #=> String
    #   resp.engine_configuration.coordinator_dpu_size #=> Integer
    #   resp.engine_configuration.max_concurrent_dpus #=> Integer
    #   resp.engine_configuration.default_executor_dpu_size #=> Integer
    #   resp.engine_configuration.additional_configs #=> Hash
    #   resp.engine_configuration.additional_configs["KeyString"] #=> String
    #   resp.engine_configuration.spark_properties #=> Hash
    #   resp.engine_configuration.spark_properties["KeyString"] #=> String
    #   resp.notebook_version #=> String
    #   resp.session_configuration.execution_role #=> String
    #   resp.session_configuration.working_directory #=> String
    #   resp.session_configuration.idle_timeout_seconds #=> Integer
    #   resp.session_configuration.encryption_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS", "CSE_KMS"
    #   resp.session_configuration.encryption_configuration.kms_key #=> String
    #   resp.status.start_date_time #=> Time
    #   resp.status.last_modified_date_time #=> Time
    #   resp.status.end_date_time #=> Time
    #   resp.status.idle_since_date_time #=> Time
    #   resp.status.state #=> String, one of "CREATING", "CREATED", "IDLE", "BUSY", "TERMINATING", "TERMINATED", "DEGRADED", "FAILED"
    #   resp.status.state_change_reason #=> String
    #   resp.statistics.dpu_execution_in_millis #=> Integer
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetSession AWS API Documentation
    #
    # @overload get_session(params = {})
    # @param [Hash] params ({})
    def get_session(params = {}, options = {})
      req = build_request(:get_session, params)
      req.send_request(options)
    end

    # Gets the current status of a session.
    #
    # @option params [required, String] :session_id
    #   The session ID.
    #
    # @return [Types::GetSessionStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetSessionStatusResponse#session_id #session_id} => String
    #   * {Types::GetSessionStatusResponse#status #status} => Types::SessionStatus
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_session_status({
    #     session_id: "SessionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.session_id #=> String
    #   resp.status.start_date_time #=> Time
    #   resp.status.last_modified_date_time #=> Time
    #   resp.status.end_date_time #=> Time
    #   resp.status.idle_since_date_time #=> Time
    #   resp.status.state #=> String, one of "CREATING", "CREATED", "IDLE", "BUSY", "TERMINATING", "TERMINATED", "DEGRADED", "FAILED"
    #   resp.status.state_change_reason #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetSessionStatus AWS API Documentation
    #
    # @overload get_session_status(params = {})
    # @param [Hash] params ({})
    def get_session_status(params = {}, options = {})
      req = build_request(:get_session_status, params)
      req.send_request(options)
    end

    # Returns table metadata for the specified catalog, database, and table.
    #
    # @option params [required, String] :catalog_name
    #   The name of the data catalog that contains the database and table
    #   metadata to return.
    #
    # @option params [required, String] :database_name
    #   The name of the database that contains the table metadata to return.
    #
    # @option params [required, String] :table_name
    #   The name of the table for which metadata is returned.
    #
    # @option params [String] :work_group
    #   The name of the workgroup for which the metadata is being fetched.
    #   Required if requesting an IAM Identity Center enabled Glue Data
    #   Catalog.
    #
    # @return [Types::GetTableMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetTableMetadataOutput#table_metadata #table_metadata} => Types::TableMetadata
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_table_metadata({
    #     catalog_name: "CatalogNameString", # required
    #     database_name: "NameString", # required
    #     table_name: "NameString", # required
    #     work_group: "WorkGroupName",
    #   })
    #
    # @example Response structure
    #
    #   resp.table_metadata.name #=> String
    #   resp.table_metadata.create_time #=> Time
    #   resp.table_metadata.last_access_time #=> Time
    #   resp.table_metadata.table_type #=> String
    #   resp.table_metadata.columns #=> Array
    #   resp.table_metadata.columns[0].name #=> String
    #   resp.table_metadata.columns[0].type #=> String
    #   resp.table_metadata.columns[0].comment #=> String
    #   resp.table_metadata.partition_keys #=> Array
    #   resp.table_metadata.partition_keys[0].name #=> String
    #   resp.table_metadata.partition_keys[0].type #=> String
    #   resp.table_metadata.partition_keys[0].comment #=> String
    #   resp.table_metadata.parameters #=> Hash
    #   resp.table_metadata.parameters["KeyString"] #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetTableMetadata AWS API Documentation
    #
    # @overload get_table_metadata(params = {})
    # @param [Hash] params ({})
    def get_table_metadata(params = {}, options = {})
      req = build_request(:get_table_metadata, params)
      req.send_request(options)
    end

    # Returns information about the workgroup with the specified name.
    #
    # @option params [required, String] :work_group
    #   The name of the workgroup.
    #
    # @return [Types::GetWorkGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetWorkGroupOutput#work_group #work_group} => Types::WorkGroup
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_work_group({
    #     work_group: "WorkGroupName", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.work_group.name #=> String
    #   resp.work_group.state #=> String, one of "ENABLED", "DISABLED"
    #   resp.work_group.configuration.result_configuration.output_location #=> String
    #   resp.work_group.configuration.result_configuration.encryption_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS", "CSE_KMS"
    #   resp.work_group.configuration.result_configuration.encryption_configuration.kms_key #=> String
    #   resp.work_group.configuration.result_configuration.expected_bucket_owner #=> String
    #   resp.work_group.configuration.result_configuration.acl_configuration.s3_acl_option #=> String, one of "BUCKET_OWNER_FULL_CONTROL"
    #   resp.work_group.configuration.managed_query_results_configuration.enabled #=> Boolean
    #   resp.work_group.configuration.managed_query_results_configuration.encryption_configuration.kms_key #=> String
    #   resp.work_group.configuration.enforce_work_group_configuration #=> Boolean
    #   resp.work_group.configuration.publish_cloud_watch_metrics_enabled #=> Boolean
    #   resp.work_group.configuration.bytes_scanned_cutoff_per_query #=> Integer
    #   resp.work_group.configuration.requester_pays_enabled #=> Boolean
    #   resp.work_group.configuration.engine_version.selected_engine_version #=> String
    #   resp.work_group.configuration.engine_version.effective_engine_version #=> String
    #   resp.work_group.configuration.additional_configuration #=> String
    #   resp.work_group.configuration.execution_role #=> String
    #   resp.work_group.configuration.customer_content_encryption_configuration.kms_key #=> String
    #   resp.work_group.configuration.enable_minimum_encryption_configuration #=> Boolean
    #   resp.work_group.configuration.identity_center_configuration.enable_identity_center #=> Boolean
    #   resp.work_group.configuration.identity_center_configuration.identity_center_instance_arn #=> String
    #   resp.work_group.configuration.query_results_s3_access_grants_configuration.enable_s3_access_grants #=> Boolean
    #   resp.work_group.configuration.query_results_s3_access_grants_configuration.create_user_level_prefix #=> Boolean
    #   resp.work_group.configuration.query_results_s3_access_grants_configuration.authentication_type #=> String, one of "DIRECTORY_IDENTITY"
    #   resp.work_group.description #=> String
    #   resp.work_group.creation_time #=> Time
    #   resp.work_group.identity_center_application_arn #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetWorkGroup AWS API Documentation
    #
    # @overload get_work_group(params = {})
    # @param [Hash] params ({})
    def get_work_group(params = {}, options = {})
      req = build_request(:get_work_group, params)
      req.send_request(options)
    end

    # Imports a single `ipynb` file to a Spark enabled workgroup. To import
    # the notebook, the request must specify a value for either `Payload` or
    # `NoteBookS3LocationUri`. If neither is specified or both are
    # specified, an `InvalidRequestException` occurs. The maximum file size
    # that can be imported is 10 megabytes. If an `ipynb` file with the same
    # name already exists in the workgroup, throws an error.
    #
    # @option params [required, String] :work_group
    #   The name of the Spark enabled workgroup to import the notebook to.
    #
    # @option params [required, String] :name
    #   The name of the notebook to import.
    #
    # @option params [String] :payload
    #   The notebook content to be imported. The payload must be in `ipynb`
    #   format.
    #
    # @option params [required, String] :type
    #   The notebook content type. Currently, the only valid type is `IPYNB`.
    #
    # @option params [String] :notebook_s3_location_uri
    #   A URI that specifies the Amazon S3 location of a notebook file in
    #   `ipynb` format.
    #
    # @option params [String] :client_request_token
    #   A unique case-sensitive string used to ensure the request to import
    #   the notebook is idempotent (executes only once).
    #
    #   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 you. 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.
    #
    # @return [Types::ImportNotebookOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ImportNotebookOutput#notebook_id #notebook_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.import_notebook({
    #     work_group: "WorkGroupName", # required
    #     name: "NotebookName", # required
    #     payload: "Payload",
    #     type: "IPYNB", # required, accepts IPYNB
    #     notebook_s3_location_uri: "S3Uri",
    #     client_request_token: "ClientRequestToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.notebook_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ImportNotebook AWS API Documentation
    #
    # @overload import_notebook(params = {})
    # @param [Hash] params ({})
    def import_notebook(params = {}, options = {})
      req = build_request(:import_notebook, params)
      req.send_request(options)
    end

    # Returns the supported DPU sizes for the supported application runtimes
    # (for example, `Athena notebook version 1`).
    #
    # @option params [Integer] :max_results
    #   Specifies the maximum number of results to return.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated.
    #
    # @return [Types::ListApplicationDPUSizesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListApplicationDPUSizesOutput#application_dpu_sizes #application_dpu_sizes} => Array&lt;Types::ApplicationDPUSizes&gt;
    #   * {Types::ListApplicationDPUSizesOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_application_dpu_sizes({
    #     max_results: 1,
    #     next_token: "Token",
    #   })
    #
    # @example Response structure
    #
    #   resp.application_dpu_sizes #=> Array
    #   resp.application_dpu_sizes[0].application_runtime_id #=> String
    #   resp.application_dpu_sizes[0].supported_dpu_sizes #=> Array
    #   resp.application_dpu_sizes[0].supported_dpu_sizes[0] #=> Integer
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListApplicationDPUSizes AWS API Documentation
    #
    # @overload list_application_dpu_sizes(params = {})
    # @param [Hash] params ({})
    def list_application_dpu_sizes(params = {}, options = {})
      req = build_request(:list_application_dpu_sizes, params)
      req.send_request(options)
    end

    # Lists the calculations that have been submitted to a session in
    # descending order. Newer calculations are listed first; older
    # calculations are listed later.
    #
    # @option params [required, String] :session_id
    #   The session ID.
    #
    # @option params [String] :state_filter
    #   A filter for a specific calculation execution state. A description of
    #   each state follows.
    #
    #   `CREATING` - The calculation is in the process of being created.
    #
    #   `CREATED` - The calculation has been created and is ready to run.
    #
    #   `QUEUED` - The calculation has been queued for processing.
    #
    #   `RUNNING` - The calculation is running.
    #
    #   `CANCELING` - A request to cancel the calculation has been received
    #   and the system is working to stop it.
    #
    #   `CANCELED` - The calculation is no longer running as the result of a
    #   cancel request.
    #
    #   `COMPLETED` - The calculation has completed without error.
    #
    #   `FAILED` - The calculation failed and is no longer running.
    #
    # @option params [Integer] :max_results
    #   The maximum number of calculation executions to return.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @return [Types::ListCalculationExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListCalculationExecutionsResponse#next_token #next_token} => String
    #   * {Types::ListCalculationExecutionsResponse#calculations #calculations} => Array&lt;Types::CalculationSummary&gt;
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_calculation_executions({
    #     session_id: "SessionId", # required
    #     state_filter: "CREATING", # accepts CREATING, CREATED, QUEUED, RUNNING, CANCELING, CANCELED, COMPLETED, FAILED
    #     max_results: 1,
    #     next_token: "SessionManagerToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.next_token #=> String
    #   resp.calculations #=> Array
    #   resp.calculations[0].calculation_execution_id #=> String
    #   resp.calculations[0].description #=> String
    #   resp.calculations[0].status.submission_date_time #=> Time
    #   resp.calculations[0].status.completion_date_time #=> Time
    #   resp.calculations[0].status.state #=> String, one of "CREATING", "CREATED", "QUEUED", "RUNNING", "CANCELING", "CANCELED", "COMPLETED", "FAILED"
    #   resp.calculations[0].status.state_change_reason #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListCalculationExecutions AWS API Documentation
    #
    # @overload list_calculation_executions(params = {})
    # @param [Hash] params ({})
    def list_calculation_executions(params = {}, options = {})
      req = build_request(:list_calculation_executions, params)
      req.send_request(options)
    end

    # Lists the capacity reservations for the current account.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated.
    #
    # @option params [Integer] :max_results
    #   Specifies the maximum number of results to return.
    #
    # @return [Types::ListCapacityReservationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListCapacityReservationsOutput#next_token #next_token} => String
    #   * {Types::ListCapacityReservationsOutput#capacity_reservations #capacity_reservations} => Array&lt;Types::CapacityReservation&gt;
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_capacity_reservations({
    #     next_token: "Token",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.next_token #=> String
    #   resp.capacity_reservations #=> Array
    #   resp.capacity_reservations[0].name #=> String
    #   resp.capacity_reservations[0].status #=> String, one of "PENDING", "ACTIVE", "CANCELLING", "CANCELLED", "FAILED", "UPDATE_PENDING"
    #   resp.capacity_reservations[0].target_dpus #=> Integer
    #   resp.capacity_reservations[0].allocated_dpus #=> Integer
    #   resp.capacity_reservations[0].last_allocation.status #=> String, one of "PENDING", "SUCCEEDED", "FAILED"
    #   resp.capacity_reservations[0].last_allocation.status_message #=> String
    #   resp.capacity_reservations[0].last_allocation.request_time #=> Time
    #   resp.capacity_reservations[0].last_allocation.request_completion_time #=> Time
    #   resp.capacity_reservations[0].last_successful_allocation_time #=> Time
    #   resp.capacity_reservations[0].creation_time #=> Time
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListCapacityReservations AWS API Documentation
    #
    # @overload list_capacity_reservations(params = {})
    # @param [Hash] params ({})
    def list_capacity_reservations(params = {}, options = {})
      req = build_request(:list_capacity_reservations, params)
      req.send_request(options)
    end

    # Lists the data catalogs in the current Amazon Web Services account.
    #
    # <note markdown="1"> In the Athena console, data catalogs are listed as "data sources" on
    # the **Data sources** page under the **Data source name** column.
    #
    #  </note>
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the NextToken from the response object of
    #   the previous page call.
    #
    # @option params [Integer] :max_results
    #   Specifies the maximum number of data catalogs to return.
    #
    # @option params [String] :work_group
    #   The name of the workgroup. Required if making an IAM Identity Center
    #   request.
    #
    # @return [Types::ListDataCatalogsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListDataCatalogsOutput#data_catalogs_summary #data_catalogs_summary} => Array&lt;Types::DataCatalogSummary&gt;
    #   * {Types::ListDataCatalogsOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_data_catalogs({
    #     next_token: "Token",
    #     max_results: 1,
    #     work_group: "WorkGroupName",
    #   })
    #
    # @example Response structure
    #
    #   resp.data_catalogs_summary #=> Array
    #   resp.data_catalogs_summary[0].catalog_name #=> String
    #   resp.data_catalogs_summary[0].type #=> String, one of "LAMBDA", "GLUE", "HIVE", "FEDERATED"
    #   resp.data_catalogs_summary[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
    #   resp.data_catalogs_summary[0].connection_type #=> String, one of "DYNAMODB", "MYSQL", "POSTGRESQL", "REDSHIFT", "ORACLE", "SYNAPSE", "SQLSERVER", "DB2", "OPENSEARCH", "BIGQUERY", "GOOGLECLOUDSTORAGE", "HBASE", "DOCUMENTDB", "CMDB", "TPCDS", "TIMESTREAM", "SAPHANA", "SNOWFLAKE", "DATALAKEGEN2", "DB2AS400"
    #   resp.data_catalogs_summary[0].error #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDataCatalogs AWS API Documentation
    #
    # @overload list_data_catalogs(params = {})
    # @param [Hash] params ({})
    def list_data_catalogs(params = {}, options = {})
      req = build_request(:list_data_catalogs, params)
      req.send_request(options)
    end

    # Lists the databases in the specified data catalog.
    #
    # @option params [required, String] :catalog_name
    #   The name of the data catalog that contains the databases to return.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @option params [Integer] :max_results
    #   Specifies the maximum number of results to return.
    #
    # @option params [String] :work_group
    #   The name of the workgroup for which the metadata is being fetched.
    #   Required if requesting an IAM Identity Center enabled Glue Data
    #   Catalog.
    #
    # @return [Types::ListDatabasesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListDatabasesOutput#database_list #database_list} => Array&lt;Types::Database&gt;
    #   * {Types::ListDatabasesOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_databases({
    #     catalog_name: "CatalogNameString", # required
    #     next_token: "Token",
    #     max_results: 1,
    #     work_group: "WorkGroupName",
    #   })
    #
    # @example Response structure
    #
    #   resp.database_list #=> Array
    #   resp.database_list[0].name #=> String
    #   resp.database_list[0].description #=> String
    #   resp.database_list[0].parameters #=> Hash
    #   resp.database_list[0].parameters["KeyString"] #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListDatabases AWS API Documentation
    #
    # @overload list_databases(params = {})
    # @param [Hash] params ({})
    def list_databases(params = {}, options = {})
      req = build_request(:list_databases, params)
      req.send_request(options)
    end

    # Returns a list of engine versions that are available to choose from,
    # including the Auto option.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @option params [Integer] :max_results
    #   The maximum number of engine versions to return in this request.
    #
    # @return [Types::ListEngineVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListEngineVersionsOutput#engine_versions #engine_versions} => Array&lt;Types::EngineVersion&gt;
    #   * {Types::ListEngineVersionsOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_engine_versions({
    #     next_token: "Token",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.engine_versions #=> Array
    #   resp.engine_versions[0].selected_engine_version #=> String
    #   resp.engine_versions[0].effective_engine_version #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListEngineVersions AWS API Documentation
    #
    # @overload list_engine_versions(params = {})
    # @param [Hash] params ({})
    def list_engine_versions(params = {}, options = {})
      req = build_request(:list_engine_versions, params)
      req.send_request(options)
    end

    # Lists, in descending order, the executors that joined a session. Newer
    # executors are listed first; older executors are listed later. The
    # result can be optionally filtered by state.
    #
    # @option params [required, String] :session_id
    #   The session ID.
    #
    # @option params [String] :executor_state_filter
    #   A filter for a specific executor state. A description of each state
    #   follows.
    #
    #   `CREATING` - The executor is being started, including acquiring
    #   resources.
    #
    #   `CREATED` - The executor has been started.
    #
    #   `REGISTERED` - The executor has been registered.
    #
    #   `TERMINATING` - The executor is in the process of shutting down.
    #
    #   `TERMINATED` - The executor is no longer running.
    #
    #   `FAILED` - Due to a failure, the executor is no longer running.
    #
    # @option params [Integer] :max_results
    #   The maximum number of executors to return.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @return [Types::ListExecutorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListExecutorsResponse#session_id #session_id} => String
    #   * {Types::ListExecutorsResponse#next_token #next_token} => String
    #   * {Types::ListExecutorsResponse#executors_summary #executors_summary} => Array&lt;Types::ExecutorsSummary&gt;
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_executors({
    #     session_id: "SessionId", # required
    #     executor_state_filter: "CREATING", # accepts CREATING, CREATED, REGISTERED, TERMINATING, TERMINATED, FAILED
    #     max_results: 1,
    #     next_token: "SessionManagerToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.session_id #=> String
    #   resp.next_token #=> String
    #   resp.executors_summary #=> Array
    #   resp.executors_summary[0].executor_id #=> String
    #   resp.executors_summary[0].executor_type #=> String, one of "COORDINATOR", "GATEWAY", "WORKER"
    #   resp.executors_summary[0].start_date_time #=> Integer
    #   resp.executors_summary[0].termination_date_time #=> Integer
    #   resp.executors_summary[0].executor_state #=> String, one of "CREATING", "CREATED", "REGISTERED", "TERMINATING", "TERMINATED", "FAILED"
    #   resp.executors_summary[0].executor_size #=> Integer
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListExecutors AWS API Documentation
    #
    # @overload list_executors(params = {})
    # @param [Hash] params ({})
    def list_executors(params = {}, options = {})
      req = build_request(:list_executors, params)
      req.send_request(options)
    end

    # Provides a list of available query IDs only for queries saved in the
    # specified workgroup. Requires that you have access to the specified
    # workgroup. If a workgroup is not specified, lists the saved queries
    # for the primary workgroup.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @option params [Integer] :max_results
    #   The maximum number of queries to return in this request.
    #
    # @option params [String] :work_group
    #   The name of the workgroup from which the named queries are being
    #   returned. If a workgroup is not specified, the saved queries for the
    #   primary workgroup are returned.
    #
    # @return [Types::ListNamedQueriesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListNamedQueriesOutput#named_query_ids #named_query_ids} => Array&lt;String&gt;
    #   * {Types::ListNamedQueriesOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_named_queries({
    #     next_token: "Token",
    #     max_results: 1,
    #     work_group: "WorkGroupName",
    #   })
    #
    # @example Response structure
    #
    #   resp.named_query_ids #=> Array
    #   resp.named_query_ids[0] #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNamedQueries AWS API Documentation
    #
    # @overload list_named_queries(params = {})
    # @param [Hash] params ({})
    def list_named_queries(params = {}, options = {})
      req = build_request(:list_named_queries, params)
      req.send_request(options)
    end

    # Displays the notebook files for the specified workgroup in paginated
    # format.
    #
    # @option params [Types::FilterDefinition] :filters
    #   Search filter string.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated.
    #
    # @option params [Integer] :max_results
    #   Specifies the maximum number of results to return.
    #
    # @option params [required, String] :work_group
    #   The name of the Spark enabled workgroup to retrieve notebook metadata
    #   for.
    #
    # @return [Types::ListNotebookMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListNotebookMetadataOutput#next_token #next_token} => String
    #   * {Types::ListNotebookMetadataOutput#notebook_metadata_list #notebook_metadata_list} => Array&lt;Types::NotebookMetadata&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_notebook_metadata({
    #     filters: {
    #       name: "NotebookName",
    #     },
    #     next_token: "Token",
    #     max_results: 1,
    #     work_group: "WorkGroupName", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.next_token #=> String
    #   resp.notebook_metadata_list #=> Array
    #   resp.notebook_metadata_list[0].notebook_id #=> String
    #   resp.notebook_metadata_list[0].name #=> String
    #   resp.notebook_metadata_list[0].work_group #=> String
    #   resp.notebook_metadata_list[0].creation_time #=> Time
    #   resp.notebook_metadata_list[0].type #=> String, one of "IPYNB"
    #   resp.notebook_metadata_list[0].last_modified_time #=> Time
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookMetadata AWS API Documentation
    #
    # @overload list_notebook_metadata(params = {})
    # @param [Hash] params ({})
    def list_notebook_metadata(params = {}, options = {})
      req = build_request(:list_notebook_metadata, params)
      req.send_request(options)
    end

    # Lists, in descending order, the sessions that have been created in a
    # notebook that are in an active state like `CREATING`, `CREATED`,
    # `IDLE` or `BUSY`. Newer sessions are listed first; older sessions are
    # listed later.
    #
    # @option params [required, String] :notebook_id
    #   The ID of the notebook to list sessions for.
    #
    # @option params [Integer] :max_results
    #   The maximum number of notebook sessions to return.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @return [Types::ListNotebookSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListNotebookSessionsResponse#notebook_sessions_list #notebook_sessions_list} => Array&lt;Types::NotebookSessionSummary&gt;
    #   * {Types::ListNotebookSessionsResponse#next_token #next_token} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_notebook_sessions({
    #     notebook_id: "NotebookId", # required
    #     max_results: 1,
    #     next_token: "Token",
    #   })
    #
    # @example Response structure
    #
    #   resp.notebook_sessions_list #=> Array
    #   resp.notebook_sessions_list[0].session_id #=> String
    #   resp.notebook_sessions_list[0].creation_time #=> Time
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListNotebookSessions AWS API Documentation
    #
    # @overload list_notebook_sessions(params = {})
    # @param [Hash] params ({})
    def list_notebook_sessions(params = {}, options = {})
      req = build_request(:list_notebook_sessions, params)
      req.send_request(options)
    end

    # Lists the prepared statements in the specified workgroup.
    #
    # @option params [required, String] :work_group
    #   The workgroup to list the prepared statements for.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in this request.
    #
    # @return [Types::ListPreparedStatementsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListPreparedStatementsOutput#prepared_statements #prepared_statements} => Array&lt;Types::PreparedStatementSummary&gt;
    #   * {Types::ListPreparedStatementsOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_prepared_statements({
    #     work_group: "WorkGroupName", # required
    #     next_token: "Token",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.prepared_statements #=> Array
    #   resp.prepared_statements[0].statement_name #=> String
    #   resp.prepared_statements[0].last_modified_time #=> Time
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListPreparedStatements AWS API Documentation
    #
    # @overload list_prepared_statements(params = {})
    # @param [Hash] params ({})
    def list_prepared_statements(params = {}, options = {})
      req = build_request(:list_prepared_statements, params)
      req.send_request(options)
    end

    # Provides a list of available query execution IDs for the queries in
    # the specified workgroup. Athena keeps a query history for 45 days. If
    # a workgroup is not specified, returns a list of query execution IDs
    # for the primary workgroup. Requires you to have access to the
    # workgroup in which the queries ran.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @option params [Integer] :max_results
    #   The maximum number of query executions to return in this request.
    #
    # @option params [String] :work_group
    #   The name of the workgroup from which queries are being returned. If a
    #   workgroup is not specified, a list of available query execution IDs
    #   for the queries in the primary workgroup is returned.
    #
    # @return [Types::ListQueryExecutionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListQueryExecutionsOutput#query_execution_ids #query_execution_ids} => Array&lt;String&gt;
    #   * {Types::ListQueryExecutionsOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_query_executions({
    #     next_token: "Token",
    #     max_results: 1,
    #     work_group: "WorkGroupName",
    #   })
    #
    # @example Response structure
    #
    #   resp.query_execution_ids #=> Array
    #   resp.query_execution_ids[0] #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListQueryExecutions AWS API Documentation
    #
    # @overload list_query_executions(params = {})
    # @param [Hash] params ({})
    def list_query_executions(params = {}, options = {})
      req = build_request(:list_query_executions, params)
      req.send_request(options)
    end

    # Lists the sessions in a workgroup that are in an active state like
    # `CREATING`, `CREATED`, `IDLE`, or `BUSY`. Newer sessions are listed
    # first; older sessions are listed later.
    #
    # @option params [required, String] :work_group
    #   The workgroup to which the session belongs.
    #
    # @option params [String] :state_filter
    #   A filter for a specific session state. A description of each state
    #   follows.
    #
    #   `CREATING` - The session is being started, including acquiring
    #   resources.
    #
    #   `CREATED` - The session has been started.
    #
    #   `IDLE` - The session is able to accept a calculation.
    #
    #   `BUSY` - The session is processing another task and is unable to
    #   accept a calculation.
    #
    #   `TERMINATING` - The session is in the process of shutting down.
    #
    #   `TERMINATED` - The session and its resources are no longer running.
    #
    #   `DEGRADED` - The session has no healthy coordinators.
    #
    #   `FAILED` - Due to a failure, the session and its resources are no
    #   longer running.
    #
    # @option params [Integer] :max_results
    #   The maximum number of sessions to return.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @return [Types::ListSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListSessionsResponse#next_token #next_token} => String
    #   * {Types::ListSessionsResponse#sessions #sessions} => Array&lt;Types::SessionSummary&gt;
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_sessions({
    #     work_group: "WorkGroupName", # required
    #     state_filter: "CREATING", # accepts CREATING, CREATED, IDLE, BUSY, TERMINATING, TERMINATED, DEGRADED, FAILED
    #     max_results: 1,
    #     next_token: "SessionManagerToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.next_token #=> String
    #   resp.sessions #=> Array
    #   resp.sessions[0].session_id #=> String
    #   resp.sessions[0].description #=> String
    #   resp.sessions[0].engine_version.selected_engine_version #=> String
    #   resp.sessions[0].engine_version.effective_engine_version #=> String
    #   resp.sessions[0].notebook_version #=> String
    #   resp.sessions[0].status.start_date_time #=> Time
    #   resp.sessions[0].status.last_modified_date_time #=> Time
    #   resp.sessions[0].status.end_date_time #=> Time
    #   resp.sessions[0].status.idle_since_date_time #=> Time
    #   resp.sessions[0].status.state #=> String, one of "CREATING", "CREATED", "IDLE", "BUSY", "TERMINATING", "TERMINATED", "DEGRADED", "FAILED"
    #   resp.sessions[0].status.state_change_reason #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListSessions AWS API Documentation
    #
    # @overload list_sessions(params = {})
    # @param [Hash] params ({})
    def list_sessions(params = {}, options = {})
      req = build_request(:list_sessions, params)
      req.send_request(options)
    end

    # Lists the metadata for the tables in the specified data catalog
    # database.
    #
    # @option params [required, String] :catalog_name
    #   The name of the data catalog for which table metadata should be
    #   returned.
    #
    # @option params [required, String] :database_name
    #   The name of the database for which table metadata should be returned.
    #
    # @option params [String] :expression
    #   A regex filter that pattern-matches table names. If no expression is
    #   supplied, metadata for all tables are listed.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the NextToken from the response object of
    #   the previous page call.
    #
    # @option params [Integer] :max_results
    #   Specifies the maximum number of results to return.
    #
    # @option params [String] :work_group
    #   The name of the workgroup for which the metadata is being fetched.
    #   Required if requesting an IAM Identity Center enabled Glue Data
    #   Catalog.
    #
    # @return [Types::ListTableMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListTableMetadataOutput#table_metadata_list #table_metadata_list} => Array&lt;Types::TableMetadata&gt;
    #   * {Types::ListTableMetadataOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_table_metadata({
    #     catalog_name: "CatalogNameString", # required
    #     database_name: "NameString", # required
    #     expression: "ExpressionString",
    #     next_token: "Token",
    #     max_results: 1,
    #     work_group: "WorkGroupName",
    #   })
    #
    # @example Response structure
    #
    #   resp.table_metadata_list #=> Array
    #   resp.table_metadata_list[0].name #=> String
    #   resp.table_metadata_list[0].create_time #=> Time
    #   resp.table_metadata_list[0].last_access_time #=> Time
    #   resp.table_metadata_list[0].table_type #=> String
    #   resp.table_metadata_list[0].columns #=> Array
    #   resp.table_metadata_list[0].columns[0].name #=> String
    #   resp.table_metadata_list[0].columns[0].type #=> String
    #   resp.table_metadata_list[0].columns[0].comment #=> String
    #   resp.table_metadata_list[0].partition_keys #=> Array
    #   resp.table_metadata_list[0].partition_keys[0].name #=> String
    #   resp.table_metadata_list[0].partition_keys[0].type #=> String
    #   resp.table_metadata_list[0].partition_keys[0].comment #=> String
    #   resp.table_metadata_list[0].parameters #=> Hash
    #   resp.table_metadata_list[0].parameters["KeyString"] #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTableMetadata AWS API Documentation
    #
    # @overload list_table_metadata(params = {})
    # @param [Hash] params ({})
    def list_table_metadata(params = {}, options = {})
      req = build_request(:list_table_metadata, params)
      req.send_request(options)
    end

    # Lists the tags associated with an Athena resource.
    #
    # @option params [required, String] :resource_arn
    #   Lists the tags for the resource with the specified ARN.
    #
    # @option params [String] :next_token
    #   The token for the next set of results, or null if there are no
    #   additional results for this request, where the request lists the tags
    #   for the resource with the specified ARN.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to be returned per request that lists
    #   the tags for the resource.
    #
    # @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListTagsForResourceOutput#tags #tags} => Array&lt;Types::Tag&gt;
    #   * {Types::ListTagsForResourceOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_tags_for_resource({
    #     resource_arn: "AmazonResourceName", # required
    #     next_token: "Token",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.tags #=> Array
    #   resp.tags[0].key #=> String
    #   resp.tags[0].value #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListTagsForResource AWS API Documentation
    #
    # @overload list_tags_for_resource(params = {})
    # @param [Hash] params ({})
    def list_tags_for_resource(params = {}, options = {})
      req = build_request(:list_tags_for_resource, params)
      req.send_request(options)
    end

    # Lists available workgroups for the account.
    #
    # @option params [String] :next_token
    #   A token generated by the Athena service that specifies where to
    #   continue pagination if a previous request was truncated. To obtain the
    #   next set of pages, pass in the `NextToken` from the response object of
    #   the previous page call.
    #
    # @option params [Integer] :max_results
    #   The maximum number of workgroups to return in this request.
    #
    # @return [Types::ListWorkGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListWorkGroupsOutput#work_groups #work_groups} => Array&lt;Types::WorkGroupSummary&gt;
    #   * {Types::ListWorkGroupsOutput#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_work_groups({
    #     next_token: "Token",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.work_groups #=> Array
    #   resp.work_groups[0].name #=> String
    #   resp.work_groups[0].state #=> String, one of "ENABLED", "DISABLED"
    #   resp.work_groups[0].description #=> String
    #   resp.work_groups[0].creation_time #=> Time
    #   resp.work_groups[0].engine_version.selected_engine_version #=> String
    #   resp.work_groups[0].engine_version.effective_engine_version #=> String
    #   resp.work_groups[0].identity_center_application_arn #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/ListWorkGroups AWS API Documentation
    #
    # @overload list_work_groups(params = {})
    # @param [Hash] params ({})
    def list_work_groups(params = {}, options = {})
      req = build_request(:list_work_groups, params)
      req.send_request(options)
    end

    # Puts a new capacity assignment configuration for a specified capacity
    # reservation. If a capacity assignment configuration already exists for
    # the capacity reservation, replaces the existing capacity assignment
    # configuration.
    #
    # @option params [required, String] :capacity_reservation_name
    #   The name of the capacity reservation to put a capacity assignment
    #   configuration for.
    #
    # @option params [required, Array<Types::CapacityAssignment>] :capacity_assignments
    #   The list of assignments for the capacity assignment configuration.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.put_capacity_assignment_configuration({
    #     capacity_reservation_name: "CapacityReservationName", # required
    #     capacity_assignments: [ # required
    #       {
    #         work_group_names: ["WorkGroupName"],
    #       },
    #     ],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/PutCapacityAssignmentConfiguration AWS API Documentation
    #
    # @overload put_capacity_assignment_configuration(params = {})
    # @param [Hash] params ({})
    def put_capacity_assignment_configuration(params = {}, options = {})
      req = build_request(:put_capacity_assignment_configuration, params)
      req.send_request(options)
    end

    # Submits calculations for execution within a session. You can supply
    # the code to run as an inline code block within the request.
    #
    # <note markdown="1"> The request syntax requires the
    # StartCalculationExecutionRequest$CodeBlock parameter or the
    # CalculationConfiguration$CodeBlock parameter, but not both. Because
    # CalculationConfiguration$CodeBlock is deprecated, use the
    # StartCalculationExecutionRequest$CodeBlock parameter instead.
    #
    #  </note>
    #
    # @option params [required, String] :session_id
    #   The session ID.
    #
    # @option params [String] :description
    #   A description of the calculation.
    #
    # @option params [Types::CalculationConfiguration] :calculation_configuration
    #   Contains configuration information for the calculation.
    #
    # @option params [String] :code_block
    #   A string that contains the code of the calculation. Use this parameter
    #   instead of CalculationConfiguration$CodeBlock, which is deprecated.
    #
    # @option params [String] :client_request_token
    #   A unique case-sensitive string used to ensure the request to create
    #   the calculation is idempotent (executes only once). If another
    #   `StartCalculationExecutionRequest` is received, the same response is
    #   returned and another calculation is not created. If a parameter has
    #   changed, 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.
    #
    # @return [Types::StartCalculationExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::StartCalculationExecutionResponse#calculation_execution_id #calculation_execution_id} => String
    #   * {Types::StartCalculationExecutionResponse#state #state} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.start_calculation_execution({
    #     session_id: "SessionId", # required
    #     description: "DescriptionString",
    #     calculation_configuration: {
    #       code_block: "CodeBlock",
    #     },
    #     code_block: "CodeBlock",
    #     client_request_token: "IdempotencyToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.calculation_execution_id #=> String
    #   resp.state #=> String, one of "CREATING", "CREATED", "QUEUED", "RUNNING", "CANCELING", "CANCELED", "COMPLETED", "FAILED"
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartCalculationExecution AWS API Documentation
    #
    # @overload start_calculation_execution(params = {})
    # @param [Hash] params ({})
    def start_calculation_execution(params = {}, options = {})
      req = build_request(:start_calculation_execution, params)
      req.send_request(options)
    end

    # Runs the SQL query statements contained in the `Query`. Requires you
    # to have access to the workgroup in which the query ran. Running
    # queries against an external catalog requires GetDataCatalog permission
    # to the catalog. For code samples using the Amazon Web Services SDK for
    # Java, see [Examples and Code Samples][1] in the *Amazon Athena User
    # Guide*.
    #
    #
    #
    # [1]: http://docs.aws.amazon.com/athena/latest/ug/code-samples.html
    #
    # @option params [required, String] :query_string
    #   The SQL query statements to be executed.
    #
    # @option params [String] :client_request_token
    #   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. An error is returned if a
    #   parameter, such as `QueryString`, has changed. A call to
    #   `StartQueryExecution` that uses a previous client request token
    #   returns the same `QueryExecutionId` even if the requester doesn't
    #   have permission on the tables specified in `QueryString`.
    #
    #   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.**
    #
    # @option params [Types::QueryExecutionContext] :query_execution_context
    #   The database within which the query executes.
    #
    # @option params [Types::ResultConfiguration] :result_configuration
    #   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.
    #
    # @option params [String] :work_group
    #   The name of the workgroup in which the query is being started.
    #
    # @option params [Array<String>] :execution_parameters
    #   A list of values for the parameters in a query. The values are applied
    #   sequentially to the parameters in the query in the order in which the
    #   parameters occur.
    #
    # @option params [Types::ResultReuseConfiguration] :result_reuse_configuration
    #   Specifies the query result reuse behavior for the query.
    #
    # @return [Types::StartQueryExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::StartQueryExecutionOutput#query_execution_id #query_execution_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.start_query_execution({
    #     query_string: "QueryString", # required
    #     client_request_token: "IdempotencyToken",
    #     query_execution_context: {
    #       database: "DatabaseString",
    #       catalog: "CatalogNameString",
    #     },
    #     result_configuration: {
    #       output_location: "ResultOutputLocation",
    #       encryption_configuration: {
    #         encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
    #         kms_key: "String",
    #       },
    #       expected_bucket_owner: "AwsAccountId",
    #       acl_configuration: {
    #         s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
    #       },
    #     },
    #     work_group: "WorkGroupName",
    #     execution_parameters: ["ExecutionParameter"],
    #     result_reuse_configuration: {
    #       result_reuse_by_age_configuration: {
    #         enabled: false, # required
    #         max_age_in_minutes: 1,
    #       },
    #     },
    #   })
    #
    # @example Response structure
    #
    #   resp.query_execution_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartQueryExecution AWS API Documentation
    #
    # @overload start_query_execution(params = {})
    # @param [Hash] params ({})
    def start_query_execution(params = {}, options = {})
      req = build_request(:start_query_execution, params)
      req.send_request(options)
    end

    # Creates a session for running calculations within a workgroup. The
    # session is ready when it reaches an `IDLE` state.
    #
    # @option params [String] :description
    #   The session description.
    #
    # @option params [required, String] :work_group
    #   The workgroup to which the session belongs.
    #
    # @option params [required, Types::EngineConfiguration] :engine_configuration
    #   Contains engine data processing unit (DPU) configuration settings and
    #   parameter mappings.
    #
    # @option params [String] :notebook_version
    #   The notebook version. This value is supplied automatically for
    #   notebook sessions in the Athena console and is not required for
    #   programmatic session access. The only valid notebook version is
    #   `Athena notebook version 1`. If you specify a value for
    #   `NotebookVersion`, you must also specify a value for `NotebookId`. See
    #   EngineConfiguration$AdditionalConfigs.
    #
    # @option params [Integer] :session_idle_timeout_in_minutes
    #   The idle timeout in minutes for the session.
    #
    # @option params [String] :client_request_token
    #   A unique case-sensitive string used to ensure the request to create
    #   the session is idempotent (executes only once). If another
    #   `StartSessionRequest` is received, the same response is returned and
    #   another session is not created. If a parameter has changed, 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.
    #
    # @return [Types::StartSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::StartSessionResponse#session_id #session_id} => String
    #   * {Types::StartSessionResponse#state #state} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.start_session({
    #     description: "DescriptionString",
    #     work_group: "WorkGroupName", # required
    #     engine_configuration: { # required
    #       coordinator_dpu_size: 1,
    #       max_concurrent_dpus: 1, # required
    #       default_executor_dpu_size: 1,
    #       additional_configs: {
    #         "KeyString" => "ParametersMapValue",
    #       },
    #       spark_properties: {
    #         "KeyString" => "ParametersMapValue",
    #       },
    #     },
    #     notebook_version: "NameString",
    #     session_idle_timeout_in_minutes: 1,
    #     client_request_token: "IdempotencyToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.session_id #=> String
    #   resp.state #=> String, one of "CREATING", "CREATED", "IDLE", "BUSY", "TERMINATING", "TERMINATED", "DEGRADED", "FAILED"
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StartSession AWS API Documentation
    #
    # @overload start_session(params = {})
    # @param [Hash] params ({})
    def start_session(params = {}, options = {})
      req = build_request(:start_session, params)
      req.send_request(options)
    end

    # Requests the cancellation of a calculation. A
    # `StopCalculationExecution` call on a calculation that is already in a
    # terminal state (for example, `STOPPED`, `FAILED`, or `COMPLETED`)
    # succeeds but has no effect.
    #
    # <note markdown="1"> Cancelling a calculation is done on a best effort basis. If a
    # calculation cannot be cancelled, you can be charged for its
    # completion. If you are concerned about being charged for a calculation
    # that cannot be cancelled, consider terminating the session in which
    # the calculation is running.
    #
    #  </note>
    #
    # @option params [required, String] :calculation_execution_id
    #   The calculation execution UUID.
    #
    # @return [Types::StopCalculationExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::StopCalculationExecutionResponse#state #state} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.stop_calculation_execution({
    #     calculation_execution_id: "CalculationExecutionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.state #=> String, one of "CREATING", "CREATED", "QUEUED", "RUNNING", "CANCELING", "CANCELED", "COMPLETED", "FAILED"
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopCalculationExecution AWS API Documentation
    #
    # @overload stop_calculation_execution(params = {})
    # @param [Hash] params ({})
    def stop_calculation_execution(params = {}, options = {})
      req = build_request(:stop_calculation_execution, params)
      req.send_request(options)
    end

    # Stops a query execution. Requires you to have access to the workgroup
    # in which the query ran.
    #
    # @option params [required, String] :query_execution_id
    #   The unique ID of the query execution to stop.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.stop_query_execution({
    #     query_execution_id: "QueryExecutionId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/StopQueryExecution AWS API Documentation
    #
    # @overload stop_query_execution(params = {})
    # @param [Hash] params ({})
    def stop_query_execution(params = {}, options = {})
      req = build_request(:stop_query_execution, params)
      req.send_request(options)
    end

    # Adds one or more tags to an Athena resource. A tag is a label that you
    # assign to a resource. Each tag consists of a key and an optional
    # value, both of which you define. For example, you can use tags to
    # categorize Athena workgroups, data catalogs, or capacity reservations
    # by purpose, owner, or environment. Use a consistent set of tag keys to
    # make it easier to search and filter the resources in your account. For
    # best practices, see [Tagging Best Practices][1]. Tag keys can be from
    # 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256
    # UTF-8 Unicode characters. Tags can use letters and numbers
    # representable in UTF-8, and the following characters: + - = . \_ : /
    # @. Tag keys and values are case-sensitive. Tag keys must be unique per
    # resource. If you specify more than one tag, separate them by commas.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html
    #
    # @option params [required, String] :resource_arn
    #   Specifies the ARN of the Athena resource to which tags are to be
    #   added.
    #
    # @option params [required, Array<Types::Tag>] :tags
    #   A collection of one or more tags, separated by commas, to be added to
    #   an Athena resource.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.tag_resource({
    #     resource_arn: "AmazonResourceName", # required
    #     tags: [ # required
    #       {
    #         key: "TagKey",
    #         value: "TagValue",
    #       },
    #     ],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TagResource AWS API Documentation
    #
    # @overload tag_resource(params = {})
    # @param [Hash] params ({})
    def tag_resource(params = {}, options = {})
      req = build_request(:tag_resource, params)
      req.send_request(options)
    end

    # Terminates an active session. A `TerminateSession` call on a session
    # that is already inactive (for example, in a `FAILED`, `TERMINATED` or
    # `TERMINATING` state) succeeds but has no effect. Calculations running
    # in the session when `TerminateSession` is called are forcefully
    # stopped, but may display as `FAILED` instead of `STOPPED`.
    #
    # @option params [required, String] :session_id
    #   The session ID.
    #
    # @return [Types::TerminateSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::TerminateSessionResponse#state #state} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.terminate_session({
    #     session_id: "SessionId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.state #=> String, one of "CREATING", "CREATED", "IDLE", "BUSY", "TERMINATING", "TERMINATED", "DEGRADED", "FAILED"
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/TerminateSession AWS API Documentation
    #
    # @overload terminate_session(params = {})
    # @param [Hash] params ({})
    def terminate_session(params = {}, options = {})
      req = build_request(:terminate_session, params)
      req.send_request(options)
    end

    # Removes one or more tags from an Athena resource.
    #
    # @option params [required, String] :resource_arn
    #   Specifies the ARN of the resource from which tags are to be removed.
    #
    # @option params [required, Array<String>] :tag_keys
    #   A comma-separated list of one or more tag keys whose tags are to be
    #   removed from the specified resource.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.untag_resource({
    #     resource_arn: "AmazonResourceName", # required
    #     tag_keys: ["TagKey"], # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UntagResource AWS API Documentation
    #
    # @overload untag_resource(params = {})
    # @param [Hash] params ({})
    def untag_resource(params = {}, options = {})
      req = build_request(:untag_resource, params)
      req.send_request(options)
    end

    # Updates the number of requested data processing units for the capacity
    # reservation with the specified name.
    #
    # @option params [required, Integer] :target_dpus
    #   The new number of requested data processing units.
    #
    # @option params [required, String] :name
    #   The name of the capacity reservation.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_capacity_reservation({
    #     target_dpus: 1, # required
    #     name: "CapacityReservationName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateCapacityReservation AWS API Documentation
    #
    # @overload update_capacity_reservation(params = {})
    # @param [Hash] params ({})
    def update_capacity_reservation(params = {}, options = {})
      req = build_request(:update_capacity_reservation, params)
      req.send_request(options)
    end

    # Updates the data catalog that has the specified name.
    #
    # @option params [required, String] :name
    #   The name of the data catalog to update. The catalog name must be
    #   unique for the Amazon Web Services account and can use a maximum of
    #   127 alphanumeric, underscore, at sign, or hyphen characters. The
    #   remainder of the length constraint of 256 is reserved for use by
    #   Athena.
    #
    # @option params [required, String] :type
    #   Specifies the type of data catalog to update. Specify `LAMBDA` for a
    #   federated catalog, `HIVE` for an external hive metastore, or `GLUE`
    #   for an Glue Data Catalog.
    #
    # @option params [String] :description
    #   New or modified text that describes the data catalog.
    #
    # @option params [Hash<String,String>] :parameters
    #   Specifies the Lambda function or functions to use for updating the
    #   data catalog. This is a mapping whose values depend on the catalog
    #   type.
    #
    #   * For the `HIVE` data catalog type, use the following syntax. The
    #     `metadata-function` parameter is required. `The sdk-version`
    #     parameter is optional and defaults to the currently supported
    #     version.
    #
    #     `metadata-function=lambda_arn, sdk-version=version_number `
    #
    #   * For the `LAMBDA` data catalog type, use one of the following sets of
    #     required parameters, but not both.
    #
    #     * If you have one Lambda function that processes metadata and
    #       another for reading the actual data, use the following syntax.
    #       Both parameters are required.
    #
    #       `metadata-function=lambda_arn, record-function=lambda_arn `
    #
    #     * If you have a composite Lambda function that processes both
    #       metadata and data, use the following syntax to specify your Lambda
    #       function.
    #
    #       `function=lambda_arn `
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_data_catalog({
    #     name: "CatalogNameString", # required
    #     type: "LAMBDA", # required, accepts LAMBDA, GLUE, HIVE, FEDERATED
    #     description: "DescriptionString",
    #     parameters: {
    #       "KeyString" => "ParametersMapValue",
    #     },
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateDataCatalog AWS API Documentation
    #
    # @overload update_data_catalog(params = {})
    # @param [Hash] params ({})
    def update_data_catalog(params = {}, options = {})
      req = build_request(:update_data_catalog, params)
      req.send_request(options)
    end

    # Updates a NamedQuery object. The database or workgroup cannot be
    # updated.
    #
    # @option params [required, String] :named_query_id
    #   The unique identifier (UUID) of the query.
    #
    # @option params [required, String] :name
    #   The name of the query.
    #
    # @option params [String] :description
    #   The query description.
    #
    # @option params [required, String] :query_string
    #   The contents of the query with all query statements.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_named_query({
    #     named_query_id: "NamedQueryId", # required
    #     name: "NameString", # required
    #     description: "NamedQueryDescriptionString",
    #     query_string: "QueryString", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNamedQuery AWS API Documentation
    #
    # @overload update_named_query(params = {})
    # @param [Hash] params ({})
    def update_named_query(params = {}, options = {})
      req = build_request(:update_named_query, params)
      req.send_request(options)
    end

    # Updates the contents of a Spark notebook.
    #
    # @option params [required, String] :notebook_id
    #   The ID of the notebook to update.
    #
    # @option params [required, String] :payload
    #   The updated content for the notebook.
    #
    # @option params [required, String] :type
    #   The notebook content type. Currently, the only valid type is `IPYNB`.
    #
    # @option params [String] :session_id
    #   The active notebook session ID. Required if the notebook has an active
    #   session.
    #
    # @option params [String] :client_request_token
    #   A unique case-sensitive string used to ensure the request to create
    #   the notebook is idempotent (executes only once).
    #
    #   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 you. 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.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_notebook({
    #     notebook_id: "NotebookId", # required
    #     payload: "Payload", # required
    #     type: "IPYNB", # required, accepts IPYNB
    #     session_id: "SessionId",
    #     client_request_token: "ClientRequestToken",
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebook AWS API Documentation
    #
    # @overload update_notebook(params = {})
    # @param [Hash] params ({})
    def update_notebook(params = {}, options = {})
      req = build_request(:update_notebook, params)
      req.send_request(options)
    end

    # Updates the metadata for a notebook.
    #
    # @option params [required, String] :notebook_id
    #   The ID of the notebook to update the metadata for.
    #
    # @option params [String] :client_request_token
    #   A unique case-sensitive string used to ensure the request to create
    #   the notebook is idempotent (executes only once).
    #
    #   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 you. 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.
    #
    # @option params [required, String] :name
    #   The name to update the notebook to.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_notebook_metadata({
    #     notebook_id: "NotebookId", # required
    #     client_request_token: "ClientRequestToken",
    #     name: "NotebookName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNotebookMetadata AWS API Documentation
    #
    # @overload update_notebook_metadata(params = {})
    # @param [Hash] params ({})
    def update_notebook_metadata(params = {}, options = {})
      req = build_request(:update_notebook_metadata, params)
      req.send_request(options)
    end

    # Updates a prepared statement.
    #
    # @option params [required, String] :statement_name
    #   The name of the prepared statement.
    #
    # @option params [required, String] :work_group
    #   The workgroup for the prepared statement.
    #
    # @option params [required, String] :query_statement
    #   The query string for the prepared statement.
    #
    # @option params [String] :description
    #   The description of the prepared statement.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_prepared_statement({
    #     statement_name: "StatementName", # required
    #     work_group: "WorkGroupName", # required
    #     query_statement: "QueryString", # required
    #     description: "DescriptionString",
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdatePreparedStatement AWS API Documentation
    #
    # @overload update_prepared_statement(params = {})
    # @param [Hash] params ({})
    def update_prepared_statement(params = {}, options = {})
      req = build_request(:update_prepared_statement, params)
      req.send_request(options)
    end

    # Updates the workgroup with the specified name. The workgroup's name
    # cannot be changed. Only `ConfigurationUpdates` can be specified.
    #
    # @option params [required, String] :work_group
    #   The specified workgroup that will be updated.
    #
    # @option params [String] :description
    #   The workgroup description.
    #
    # @option params [Types::WorkGroupConfigurationUpdates] :configuration_updates
    #   Contains configuration updates for an Athena SQL workgroup.
    #
    # @option params [String] :state
    #   The workgroup state that will be updated for the given workgroup.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_work_group({
    #     work_group: "WorkGroupName", # required
    #     description: "WorkGroupDescriptionString",
    #     configuration_updates: {
    #       enforce_work_group_configuration: false,
    #       result_configuration_updates: {
    #         output_location: "ResultOutputLocation",
    #         remove_output_location: false,
    #         encryption_configuration: {
    #           encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
    #           kms_key: "String",
    #         },
    #         remove_encryption_configuration: false,
    #         expected_bucket_owner: "AwsAccountId",
    #         remove_expected_bucket_owner: false,
    #         acl_configuration: {
    #           s3_acl_option: "BUCKET_OWNER_FULL_CONTROL", # required, accepts BUCKET_OWNER_FULL_CONTROL
    #         },
    #         remove_acl_configuration: false,
    #       },
    #       managed_query_results_configuration_updates: {
    #         enabled: false,
    #         encryption_configuration: {
    #           kms_key: "KmsKey", # required
    #         },
    #         remove_encryption_configuration: false,
    #       },
    #       publish_cloud_watch_metrics_enabled: false,
    #       bytes_scanned_cutoff_per_query: 1,
    #       remove_bytes_scanned_cutoff_per_query: false,
    #       requester_pays_enabled: false,
    #       engine_version: {
    #         selected_engine_version: "NameString",
    #         effective_engine_version: "NameString",
    #       },
    #       remove_customer_content_encryption_configuration: false,
    #       additional_configuration: "NameString",
    #       execution_role: "RoleArn",
    #       customer_content_encryption_configuration: {
    #         kms_key: "KmsKey", # required
    #       },
    #       enable_minimum_encryption_configuration: false,
    #       query_results_s3_access_grants_configuration: {
    #         enable_s3_access_grants: false, # required
    #         create_user_level_prefix: false,
    #         authentication_type: "DIRECTORY_IDENTITY", # required, accepts DIRECTORY_IDENTITY
    #       },
    #     },
    #     state: "ENABLED", # accepts ENABLED, DISABLED
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateWorkGroup AWS API Documentation
    #
    # @overload update_work_group(params = {})
    # @param [Hash] params ({})
    def update_work_group(params = {}, options = {})
      req = build_request(:update_work_group, params)
      req.send_request(options)
    end

    # @!endgroup

    # @param params ({})
    # @api private
    def build_request(operation_name, params = {})
      handlers = @handlers.for(operation_name)
      tracer = config.telemetry_provider.tracer_provider.tracer(
        Aws::Telemetry.module_to_tracer_name('Aws::Athena')
      )
      context = Seahorse::Client::RequestContext.new(
        operation_name: operation_name,
        operation: config.api.operation(operation_name),
        client: self,
        params: params,
        config: config,
        tracer: tracer
      )
      context[:gem_name] = 'aws-sdk-athena'
      context[:gem_version] = '1.110.0'
      Seahorse::Client::Request.new(handlers, context)
    end

    # @api private
    # @deprecated
    def waiter_names
      []
    end

    class << self

      # @api private
      attr_reader :identifier

      # @api private
      def errors_module
        Errors
      end

    end
  end
end
