Module Smaws_Client_Athena

Athena client library built on EIO.

Types

module Types : sig ... end

Builders

val make_datum : ?var_char_value:Types.datum_string -> unit -> Types.datum
val make_engine_version : ?effective_engine_version:Types.name_string -> ?selected_engine_version:Types.name_string -> unit -> Types.engine_version
val make_work_group_summary : ?identity_center_application_arn:Types.identity_center_application_arn -> ?engine_version:Types.engine_version -> ?creation_time:Types.date -> ?description:Types.work_group_description_string -> ?state:Types.work_group_state -> ?name:Types.work_group_name -> unit -> Types.work_group_summary
val make_encryption_configuration : ?kms_key:Types.string_ -> encryption_option:Types.encryption_option -> unit -> Types.encryption_configuration
val make_acl_configuration : s3_acl_option:Types.s3_acl_option -> unit -> Types.acl_configuration
val make_result_configuration_updates : ?remove_acl_configuration:Types.boxed_boolean -> ?acl_configuration:Types.acl_configuration -> ?remove_expected_bucket_owner:Types.boxed_boolean -> ?expected_bucket_owner:Types.aws_account_id -> ?remove_encryption_configuration:Types.boxed_boolean -> ?encryption_configuration:Types.encryption_configuration -> ?remove_output_location:Types.boxed_boolean -> ?output_location:Types.result_output_location -> unit -> Types.result_configuration_updates
val make_managed_query_results_encryption_configuration : kms_key:Types.kms_key -> unit -> Types.managed_query_results_encryption_configuration
val make_managed_query_results_configuration_updates : ?remove_encryption_configuration:Types.boxed_boolean -> ?encryption_configuration: Types.managed_query_results_encryption_configuration -> ?enabled:Types.boxed_boolean -> unit -> Types.managed_query_results_configuration_updates
val make_customer_content_encryption_configuration : kms_key:Types.kms_key -> unit -> Types.customer_content_encryption_configuration
val make_query_results_s3_access_grants_configuration : ?create_user_level_prefix:Types.boxed_boolean -> authentication_type:Types.authentication_type -> enable_s3_access_grants:Types.boxed_boolean -> unit -> Types.query_results_s3_access_grants_configuration
val make_cloud_watch_logging_configuration : ?log_types:Types.log_types_map -> ?log_stream_name_prefix:Types.log_stream_name_prefix -> ?log_group:Types.log_group_name -> enabled:Types.boxed_boolean -> unit -> Types.cloud_watch_logging_configuration
val make_managed_logging_configuration : ?kms_key:Types.kms_key -> enabled:Types.boxed_boolean -> unit -> Types.managed_logging_configuration
val make_s3_logging_configuration : ?log_location:Types.s3_output_location -> ?kms_key:Types.kms_key -> enabled:Types.boxed_boolean -> unit -> Types.s3_logging_configuration
val make_monitoring_configuration : ?s3_logging_configuration:Types.s3_logging_configuration -> ?managed_logging_configuration:Types.managed_logging_configuration -> ?cloud_watch_logging_configuration:Types.cloud_watch_logging_configuration -> unit -> Types.monitoring_configuration
val make_classification : ?properties:Types.parameters_map -> ?name:Types.name_string -> unit -> Types.classification
val make_engine_configuration : ?classifications:Types.classification_list -> ?spark_properties:Types.parameters_map -> ?additional_configs:Types.parameters_map -> ?default_executor_dpu_size:Types.default_executor_dpu_size -> ?max_concurrent_dpus:Types.max_concurrent_dpus -> ?coordinator_dpu_size:Types.coordinator_dpu_size -> unit -> Types.engine_configuration
val make_work_group_configuration_updates : ?engine_configuration:Types.engine_configuration -> ?monitoring_configuration:Types.monitoring_configuration -> ?query_results_s3_access_grants_configuration: Types.query_results_s3_access_grants_configuration -> ?enable_minimum_encryption_configuration:Types.boxed_boolean -> ?customer_content_encryption_configuration: Types.customer_content_encryption_configuration -> ?execution_role:Types.role_arn -> ?additional_configuration:Types.name_string -> ?remove_customer_content_encryption_configuration:Types.boxed_boolean -> ?engine_version:Types.engine_version -> ?requester_pays_enabled:Types.boxed_boolean -> ?remove_bytes_scanned_cutoff_per_query:Types.boxed_boolean -> ?bytes_scanned_cutoff_per_query:Types.bytes_scanned_cutoff_value -> ?publish_cloud_watch_metrics_enabled:Types.boxed_boolean -> ?managed_query_results_configuration_updates: Types.managed_query_results_configuration_updates -> ?result_configuration_updates:Types.result_configuration_updates -> ?enforce_work_group_configuration:Types.boxed_boolean -> unit -> Types.work_group_configuration_updates
val make_result_configuration : ?acl_configuration:Types.acl_configuration -> ?expected_bucket_owner:Types.aws_account_id -> ?encryption_configuration:Types.encryption_configuration -> ?output_location:Types.result_output_location -> unit -> Types.result_configuration
val make_managed_query_results_configuration : ?encryption_configuration: Types.managed_query_results_encryption_configuration -> enabled:Types.boolean_ -> unit -> Types.managed_query_results_configuration
val make_identity_center_configuration : ?identity_center_instance_arn:Types.identity_center_instance_arn -> ?enable_identity_center:Types.boxed_boolean -> unit -> Types.identity_center_configuration
val make_work_group_configuration : ?query_results_s3_access_grants_configuration: Types.query_results_s3_access_grants_configuration -> ?identity_center_configuration:Types.identity_center_configuration -> ?enable_minimum_encryption_configuration:Types.boxed_boolean -> ?customer_content_encryption_configuration: Types.customer_content_encryption_configuration -> ?engine_configuration:Types.engine_configuration -> ?monitoring_configuration:Types.monitoring_configuration -> ?execution_role:Types.role_arn -> ?additional_configuration:Types.name_string -> ?engine_version:Types.engine_version -> ?requester_pays_enabled:Types.boxed_boolean -> ?bytes_scanned_cutoff_per_query:Types.bytes_scanned_cutoff_value -> ?publish_cloud_watch_metrics_enabled:Types.boxed_boolean -> ?enforce_work_group_configuration:Types.boxed_boolean -> ?managed_query_results_configuration: Types.managed_query_results_configuration -> ?result_configuration:Types.result_configuration -> unit -> Types.work_group_configuration
val make_work_group : ?identity_center_application_arn:Types.identity_center_application_arn -> ?creation_time:Types.date -> ?description:Types.work_group_description_string -> ?configuration:Types.work_group_configuration -> ?state:Types.work_group_state -> name:Types.work_group_name -> unit -> Types.work_group
val make_update_work_group_output : unit -> unit
val make_update_work_group_input : ?state:Types.work_group_state -> ?configuration_updates:Types.work_group_configuration_updates -> ?description:Types.work_group_description_string -> work_group:Types.work_group_name -> unit -> Types.update_work_group_input
val make_update_prepared_statement_output : unit -> unit
val make_update_prepared_statement_input : ?description:Types.description_string -> query_statement:Types.query_string -> work_group:Types.work_group_name -> statement_name:Types.statement_name -> unit -> Types.update_prepared_statement_input
val make_update_notebook_output : unit -> unit
val make_update_notebook_metadata_output : unit -> unit
val make_update_notebook_metadata_input : ?client_request_token:Types.client_request_token -> name:Types.notebook_name -> notebook_id:Types.notebook_id -> unit -> Types.update_notebook_metadata_input
val make_update_notebook_input : ?client_request_token:Types.client_request_token -> ?session_id:Types.session_id -> type_:Types.notebook_type -> payload:Types.payload -> notebook_id:Types.notebook_id -> unit -> Types.update_notebook_input
val make_update_named_query_output : unit -> unit
val make_update_named_query_input : ?description:Types.named_query_description_string -> query_string:Types.query_string -> name:Types.name_string -> named_query_id:Types.named_query_id -> unit -> Types.update_named_query_input
val make_update_data_catalog_output : unit -> unit
val make_update_data_catalog_input : ?parameters:Types.parameters_map -> ?description:Types.description_string -> type_:Types.data_catalog_type -> name:Types.catalog_name_string -> unit -> Types.update_data_catalog_input
val make_update_capacity_reservation_output : unit -> unit
val make_update_capacity_reservation_input : name:Types.capacity_reservation_name -> target_dpus:Types.target_dpus_integer -> unit -> Types.update_capacity_reservation_input
val make_untag_resource_output : unit -> unit
val make_untag_resource_input : tag_keys:Types.tag_key_list -> resource_ar_n:Types.amazon_resource_name -> unit -> Types.untag_resource_input
val make_unprocessed_query_execution_id : ?error_message:Types.error_message -> ?error_code:Types.error_code -> ?query_execution_id:Types.query_execution_id -> unit -> Types.unprocessed_query_execution_id
val make_unprocessed_prepared_statement_name : ?error_message:Types.error_message -> ?error_code:Types.error_code -> ?statement_name:Types.statement_name -> unit -> Types.unprocessed_prepared_statement_name
val make_unprocessed_named_query_id : ?error_message:Types.error_message -> ?error_code:Types.error_code -> ?named_query_id:Types.named_query_id -> unit -> Types.unprocessed_named_query_id
val make_terminate_session_response : ?state:Types.session_state -> unit -> Types.terminate_session_response
val make_terminate_session_request : session_id:Types.session_id -> unit -> Types.terminate_session_request
val make_tag_resource_output : unit -> unit
val make_tag : ?value:Types.tag_value -> ?key:Types.tag_key -> unit -> Types.tag
val make_tag_resource_input : tags:Types.tag_list -> resource_ar_n:Types.amazon_resource_name -> unit -> Types.tag_resource_input
val make_column : ?comment:Types.comment_string -> ?type_:Types.type_string -> name:Types.name_string -> unit -> Types.column
val make_table_metadata : ?parameters:Types.parameters_map -> ?partition_keys:Types.column_list -> ?columns:Types.column_list -> ?table_type:Types.table_type_string -> ?last_access_time:Types.timestamp -> ?create_time:Types.timestamp -> name:Types.name_string -> unit -> Types.table_metadata
val make_stop_query_execution_output : unit -> unit
val make_stop_query_execution_input : query_execution_id:Types.query_execution_id -> unit -> Types.stop_query_execution_input
val make_stop_calculation_execution_response : ?state:Types.calculation_execution_state -> unit -> Types.stop_calculation_execution_response
val make_stop_calculation_execution_request : calculation_execution_id:Types.calculation_execution_id -> unit -> Types.stop_calculation_execution_request
val make_start_session_response : ?state:Types.session_state -> ?session_id:Types.session_id -> unit -> Types.start_session_response
val make_start_session_request : ?copy_work_group_tags:Types.boxed_boolean -> ?tags:Types.tag_list -> ?client_request_token:Types.idempotency_token -> ?session_idle_timeout_in_minutes:Types.session_idle_timeout_in_minutes -> ?notebook_version:Types.name_string -> ?monitoring_configuration:Types.monitoring_configuration -> ?execution_role:Types.role_arn -> ?description:Types.description_string -> engine_configuration:Types.engine_configuration -> work_group:Types.work_group_name -> unit -> Types.start_session_request
val make_start_query_execution_output : ?query_execution_id:Types.query_execution_id -> unit -> Types.start_query_execution_output
val make_query_execution_context : ?catalog:Types.catalog_name_string -> ?database:Types.database_string -> unit -> Types.query_execution_context
val make_result_reuse_by_age_configuration : ?max_age_in_minutes:Types.age -> enabled:Types.boolean_ -> unit -> Types.result_reuse_by_age_configuration
val make_result_reuse_configuration : ?result_reuse_by_age_configuration:Types.result_reuse_by_age_configuration -> unit -> Types.result_reuse_configuration
val make_start_query_execution_input : ?engine_configuration:Types.engine_configuration -> ?result_reuse_configuration:Types.result_reuse_configuration -> ?execution_parameters:Types.execution_parameters -> ?work_group:Types.work_group_name -> ?result_configuration:Types.result_configuration -> ?query_execution_context:Types.query_execution_context -> ?client_request_token:Types.idempotency_token -> query_string:Types.query_string -> unit -> Types.start_query_execution_input
val make_start_calculation_execution_response : ?state:Types.calculation_execution_state -> ?calculation_execution_id:Types.calculation_execution_id -> unit -> Types.start_calculation_execution_response
val make_calculation_configuration : ?code_block:Types.code_block -> unit -> Types.calculation_configuration
val make_start_calculation_execution_request : ?client_request_token:Types.idempotency_token -> ?code_block:Types.code_block -> ?calculation_configuration:Types.calculation_configuration -> ?description:Types.description_string -> session_id:Types.session_id -> unit -> Types.start_calculation_execution_request
val make_session_status : ?state_change_reason:Types.description_string -> ?state:Types.session_state -> ?idle_since_date_time:Types.date -> ?end_date_time:Types.date -> ?last_modified_date_time:Types.date -> ?start_date_time:Types.date -> unit -> Types.session_status
val make_session_summary : ?status:Types.session_status -> ?notebook_version:Types.name_string -> ?engine_version:Types.engine_version -> ?description:Types.description_string -> ?session_id:Types.session_id -> unit -> Types.session_summary
val make_session_statistics : ?dpu_execution_in_millis:Types.long -> unit -> Types.session_statistics
val make_session_configuration : ?encryption_configuration:Types.encryption_configuration -> ?session_idle_timeout_in_minutes:Types.session_idle_timeout_in_minutes -> ?idle_timeout_seconds:Types.long -> ?working_directory:Types.result_output_location -> ?execution_role:Types.role_arn -> unit -> Types.session_configuration
val make_row : ?data:Types.datum_list -> unit -> Types.row
val make_column_info : ?case_sensitive:Types.boolean_ -> ?nullable:Types.column_nullable -> ?scale:Types.integer -> ?precision:Types.integer -> ?label:Types.string_ -> ?table_name:Types.string_ -> ?schema_name:Types.string_ -> ?catalog_name:Types.string_ -> type_:Types.string_ -> name:Types.string_ -> unit -> Types.column_info
val make_result_set_metadata : ?column_info:Types.column_info_list -> unit -> Types.result_set_metadata
val make_result_set : ?result_set_metadata:Types.result_set_metadata -> ?rows:Types.row_list -> unit -> Types.result_set
val make_result_reuse_information : reused_previous_result:Types.boolean_ -> unit -> Types.result_reuse_information
val make_query_stage_plan_node : ?remote_sources:Types.string_list -> ?children:Types.query_stage_plan_nodes -> ?identifier:Types.string_ -> ?name:Types.string_ -> unit -> Types.query_stage_plan_node
val make_query_stage : ?sub_stages:Types.query_stages -> ?query_stage_plan:Types.query_stage_plan_node -> ?execution_time:Types.long -> ?input_rows:Types.long -> ?input_bytes:Types.long -> ?output_rows:Types.long -> ?output_bytes:Types.long -> ?state:Types.string_ -> ?stage_id:Types.long -> unit -> Types.query_stage
val make_query_runtime_statistics_timeline : ?total_execution_time_in_millis:Types.long -> ?service_processing_time_in_millis:Types.long -> ?engine_execution_time_in_millis:Types.long -> ?query_planning_time_in_millis:Types.long -> ?service_pre_processing_time_in_millis:Types.long -> ?query_queue_time_in_millis:Types.long -> unit -> Types.query_runtime_statistics_timeline
val make_query_runtime_statistics_rows : ?output_rows:Types.long -> ?output_bytes:Types.long -> ?input_bytes:Types.long -> ?input_rows:Types.long -> unit -> Types.query_runtime_statistics_rows
val make_query_runtime_statistics : ?output_stage:Types.query_stage -> ?rows:Types.query_runtime_statistics_rows -> ?timeline:Types.query_runtime_statistics_timeline -> unit -> Types.query_runtime_statistics
val make_athena_error : ?error_message:Types.string_ -> ?retryable:Types.boolean_ -> ?error_type:Types.error_type -> ?error_category:Types.error_category -> unit -> Types.athena_error
val make_query_execution_status : ?athena_error:Types.athena_error -> ?completion_date_time:Types.date -> ?submission_date_time:Types.date -> ?state_change_reason:Types.string_ -> ?state:Types.query_execution_state -> unit -> Types.query_execution_status
val make_query_execution_statistics : ?dpu_count:Types.dpu_count -> ?result_reuse_information:Types.result_reuse_information -> ?service_processing_time_in_millis:Types.long -> ?query_planning_time_in_millis:Types.long -> ?service_pre_processing_time_in_millis:Types.long -> ?query_queue_time_in_millis:Types.long -> ?total_execution_time_in_millis:Types.long -> ?data_manifest_location:Types.string_ -> ?data_scanned_in_bytes:Types.long -> ?engine_execution_time_in_millis:Types.long -> unit -> Types.query_execution_statistics
val make_query_execution : ?query_results_s3_access_grants_configuration: Types.query_results_s3_access_grants_configuration -> ?substatement_type:Types.string_ -> ?execution_parameters:Types.execution_parameters -> ?engine_version:Types.engine_version -> ?work_group:Types.work_group_name -> ?statistics:Types.query_execution_statistics -> ?status:Types.query_execution_status -> ?query_execution_context:Types.query_execution_context -> ?result_reuse_configuration:Types.result_reuse_configuration -> ?result_configuration:Types.result_configuration -> ?managed_query_results_configuration: Types.managed_query_results_configuration -> ?statement_type:Types.statement_type -> ?query:Types.query_string -> ?query_execution_id:Types.query_execution_id -> unit -> Types.query_execution
val make_put_capacity_assignment_configuration_output : unit -> unit
val make_capacity_assignment : ?work_group_names:Types.work_group_names_list -> unit -> Types.capacity_assignment
val make_put_capacity_assignment_configuration_input : capacity_assignments:Types.capacity_assignments_list -> capacity_reservation_name:Types.capacity_reservation_name -> unit -> Types.put_capacity_assignment_configuration_input
val make_prepared_statement_summary : ?last_modified_time:Types.date -> ?statement_name:Types.statement_name -> unit -> Types.prepared_statement_summary
val make_prepared_statement : ?last_modified_time:Types.date -> ?description:Types.description_string -> ?work_group_name:Types.work_group_name -> ?query_statement:Types.query_string -> ?statement_name:Types.statement_name -> unit -> Types.prepared_statement
val make_notebook_session_summary : ?creation_time:Types.date -> ?session_id:Types.session_id -> unit -> Types.notebook_session_summary
val make_notebook_metadata : ?last_modified_time:Types.date -> ?type_:Types.notebook_type -> ?creation_time:Types.date -> ?work_group:Types.work_group_name -> ?name:Types.notebook_name -> ?notebook_id:Types.notebook_id -> unit -> Types.notebook_metadata
val make_named_query : ?work_group:Types.work_group_name -> ?named_query_id:Types.named_query_id -> ?description:Types.description_string -> query_string:Types.query_string -> database:Types.database_string -> name:Types.name_string -> unit -> Types.named_query
val make_list_work_groups_output : ?next_token:Types.token -> ?work_groups:Types.work_groups_list -> unit -> Types.list_work_groups_output
val make_list_work_groups_input : ?max_results:Types.max_work_groups_count -> ?next_token:Types.token -> unit -> Types.list_work_groups_input
val make_list_tags_for_resource_output : ?next_token:Types.token -> ?tags:Types.tag_list -> unit -> Types.list_tags_for_resource_output
val make_list_tags_for_resource_input : ?max_results:Types.max_tags_count -> ?next_token:Types.token -> resource_ar_n:Types.amazon_resource_name -> unit -> Types.list_tags_for_resource_input
val make_list_table_metadata_output : ?next_token:Types.token -> ?table_metadata_list:Types.table_metadata_list -> unit -> Types.list_table_metadata_output
val make_list_table_metadata_input : ?work_group:Types.work_group_name -> ?max_results:Types.max_table_metadata_count -> ?next_token:Types.token -> ?expression:Types.expression_string -> database_name:Types.name_string -> catalog_name:Types.catalog_name_string -> unit -> Types.list_table_metadata_input
val make_list_sessions_response : ?sessions:Types.sessions_list -> ?next_token:Types.session_manager_token -> unit -> Types.list_sessions_response
val make_list_sessions_request : ?next_token:Types.session_manager_token -> ?max_results:Types.max_sessions_count -> ?state_filter:Types.session_state -> work_group:Types.work_group_name -> unit -> Types.list_sessions_request
val make_list_query_executions_output : ?next_token:Types.token -> ?query_execution_ids:Types.query_execution_id_list -> unit -> Types.list_query_executions_output
val make_list_query_executions_input : ?work_group:Types.work_group_name -> ?max_results:Types.max_query_executions_count -> ?next_token:Types.token -> unit -> Types.list_query_executions_input
val make_list_prepared_statements_output : ?next_token:Types.token -> ?prepared_statements:Types.prepared_statements_list -> unit -> Types.list_prepared_statements_output
val make_list_prepared_statements_input : ?max_results:Types.max_prepared_statements_count -> ?next_token:Types.token -> work_group:Types.work_group_name -> unit -> Types.list_prepared_statements_input
val make_list_notebook_sessions_response : ?next_token:Types.token -> notebook_sessions_list:Types.notebook_sessions_list -> unit -> Types.list_notebook_sessions_response
val make_list_notebook_sessions_request : ?next_token:Types.token -> ?max_results:Types.max_sessions_count -> notebook_id:Types.notebook_id -> unit -> Types.list_notebook_sessions_request
val make_list_notebook_metadata_output : ?notebook_metadata_list:Types.notebook_metadata_array -> ?next_token:Types.token -> unit -> Types.list_notebook_metadata_output
val make_filter_definition : ?name:Types.notebook_name -> unit -> Types.filter_definition
val make_list_notebook_metadata_input : ?max_results:Types.max_notebooks_count -> ?next_token:Types.token -> ?filters:Types.filter_definition -> work_group:Types.work_group_name -> unit -> Types.list_notebook_metadata_input
val make_list_named_queries_output : ?next_token:Types.token -> ?named_query_ids:Types.named_query_id_list -> unit -> Types.list_named_queries_output
val make_list_named_queries_input : ?work_group:Types.work_group_name -> ?max_results:Types.max_named_queries_count -> ?next_token:Types.token -> unit -> Types.list_named_queries_input
val make_executors_summary : ?executor_size:Types.long -> ?executor_state:Types.executor_state -> ?termination_date_time:Types.long -> ?start_date_time:Types.long -> ?executor_type:Types.executor_type -> executor_id:Types.executor_id -> unit -> Types.executors_summary
val make_list_executors_response : ?executors_summary:Types.executors_summary_list -> ?next_token:Types.session_manager_token -> session_id:Types.session_id -> unit -> Types.list_executors_response
val make_list_executors_request : ?next_token:Types.session_manager_token -> ?max_results:Types.max_list_executors_count -> ?executor_state_filter:Types.executor_state -> session_id:Types.session_id -> unit -> Types.list_executors_request
val make_list_engine_versions_output : ?next_token:Types.token -> ?engine_versions:Types.engine_versions_list -> unit -> Types.list_engine_versions_output
val make_list_engine_versions_input : ?max_results:Types.max_engine_versions_count -> ?next_token:Types.token -> unit -> Types.list_engine_versions_input
val make_database : ?parameters:Types.parameters_map -> ?description:Types.description_string -> name:Types.name_string -> unit -> Types.database
val make_list_databases_output : ?next_token:Types.token -> ?database_list:Types.database_list -> unit -> Types.list_databases_output
val make_list_databases_input : ?work_group:Types.work_group_name -> ?max_results:Types.max_databases_count -> ?next_token:Types.token -> catalog_name:Types.catalog_name_string -> unit -> Types.list_databases_input
val make_data_catalog_summary : ?error:Types.error_message -> ?connection_type:Types.connection_type -> ?status:Types.data_catalog_status -> ?type_:Types.data_catalog_type -> ?catalog_name:Types.catalog_name_string -> unit -> Types.data_catalog_summary
val make_list_data_catalogs_output : ?next_token:Types.token -> ?data_catalogs_summary:Types.data_catalog_summary_list -> unit -> Types.list_data_catalogs_output
val make_list_data_catalogs_input : ?work_group:Types.work_group_name -> ?max_results:Types.max_data_catalogs_count -> ?next_token:Types.token -> unit -> Types.list_data_catalogs_input
val make_capacity_allocation : ?request_completion_time:Types.timestamp -> ?status_message:Types.string_ -> request_time:Types.timestamp -> status:Types.capacity_allocation_status -> unit -> Types.capacity_allocation
val make_capacity_reservation : ?last_successful_allocation_time:Types.timestamp -> ?last_allocation:Types.capacity_allocation -> creation_time:Types.timestamp -> allocated_dpus:Types.allocated_dpus_integer -> target_dpus:Types.target_dpus_integer -> status:Types.capacity_reservation_status -> name:Types.capacity_reservation_name -> unit -> Types.capacity_reservation
val make_list_capacity_reservations_output : ?next_token:Types.token -> capacity_reservations:Types.capacity_reservations_list -> unit -> Types.list_capacity_reservations_output
val make_list_capacity_reservations_input : ?max_results:Types.max_capacity_reservations_count -> ?next_token:Types.token -> unit -> Types.list_capacity_reservations_input
val make_calculation_status : ?state_change_reason:Types.description_string -> ?state:Types.calculation_execution_state -> ?completion_date_time:Types.date -> ?submission_date_time:Types.date -> unit -> Types.calculation_status
val make_calculation_summary : ?status:Types.calculation_status -> ?description:Types.description_string -> ?calculation_execution_id:Types.calculation_execution_id -> unit -> Types.calculation_summary
val make_list_calculation_executions_response : ?calculations:Types.calculations_list -> ?next_token:Types.session_manager_token -> unit -> Types.list_calculation_executions_response
val make_list_calculation_executions_request : ?next_token:Types.session_manager_token -> ?max_results:Types.max_calculations_count -> ?state_filter:Types.calculation_execution_state -> session_id:Types.session_id -> unit -> Types.list_calculation_executions_request
val make_application_dpu_sizes : ?supported_dpu_sizes:Types.supported_dpu_size_list -> ?application_runtime_id:Types.name_string -> unit -> Types.application_dpu_sizes
val make_list_application_dpu_sizes_output : ?next_token:Types.token -> ?application_dpu_sizes:Types.application_dpu_sizes_list -> unit -> Types.list_application_dpu_sizes_output
val make_list_application_dpu_sizes_input : ?next_token:Types.token -> ?max_results:Types.max_application_dpu_sizes_count -> unit -> Types.list_application_dpu_sizes_input
val make_import_notebook_output : ?notebook_id:Types.notebook_id -> unit -> Types.import_notebook_output
val make_import_notebook_input : ?client_request_token:Types.client_request_token -> ?notebook_s3_location_uri:Types.s3_uri -> ?payload:Types.payload -> type_:Types.notebook_type -> name:Types.notebook_name -> work_group:Types.work_group_name -> unit -> Types.import_notebook_input
val make_get_work_group_output : ?work_group:Types.work_group -> unit -> Types.get_work_group_output
val make_get_work_group_input : work_group:Types.work_group_name -> unit -> Types.get_work_group_input
val make_get_table_metadata_output : ?table_metadata:Types.table_metadata -> unit -> Types.get_table_metadata_output
val make_get_table_metadata_input : ?work_group:Types.work_group_name -> table_name:Types.name_string -> database_name:Types.name_string -> catalog_name:Types.catalog_name_string -> unit -> Types.get_table_metadata_input
val make_get_session_status_response : ?status:Types.session_status -> ?session_id:Types.session_id -> unit -> Types.get_session_status_response
val make_get_session_status_request : session_id:Types.session_id -> unit -> Types.get_session_status_request
val make_get_session_response : ?statistics:Types.session_statistics -> ?status:Types.session_status -> ?session_configuration:Types.session_configuration -> ?monitoring_configuration:Types.monitoring_configuration -> ?notebook_version:Types.name_string -> ?engine_configuration:Types.engine_configuration -> ?engine_version:Types.name_string -> ?work_group:Types.work_group_name -> ?description:Types.description_string -> ?session_id:Types.session_id -> unit -> Types.get_session_response
val make_get_session_request : session_id:Types.session_id -> unit -> Types.get_session_request
val make_get_session_endpoint_response : auth_token_expiration_time:Types.timestamp -> auth_token:Types.string_ -> endpoint_url:Types.string_ -> unit -> Types.get_session_endpoint_response
val make_get_session_endpoint_request : session_id:Types.session_id -> unit -> Types.get_session_endpoint_request
val make_get_resource_dashboard_response : url:Types.string_ -> unit -> Types.get_resource_dashboard_response
val make_get_resource_dashboard_request : resource_ar_n:Types.amazon_resource_name -> unit -> Types.get_resource_dashboard_request
val make_get_query_runtime_statistics_output : ?query_runtime_statistics:Types.query_runtime_statistics -> unit -> Types.get_query_runtime_statistics_output
val make_get_query_runtime_statistics_input : query_execution_id:Types.query_execution_id -> unit -> Types.get_query_runtime_statistics_input
val make_get_query_results_output : ?next_token:Types.token -> ?result_set:Types.result_set -> ?update_count:Types.long -> unit -> Types.get_query_results_output
val make_get_query_results_input : ?query_result_type:Types.query_result_type -> ?max_results:Types.max_query_results -> ?next_token:Types.token -> query_execution_id:Types.query_execution_id -> unit -> Types.get_query_results_input
val make_get_query_execution_output : ?query_execution:Types.query_execution -> unit -> Types.get_query_execution_output
val make_get_query_execution_input : query_execution_id:Types.query_execution_id -> unit -> Types.get_query_execution_input
val make_get_prepared_statement_output : ?prepared_statement:Types.prepared_statement -> unit -> Types.get_prepared_statement_output
val make_get_prepared_statement_input : work_group:Types.work_group_name -> statement_name:Types.statement_name -> unit -> Types.get_prepared_statement_input
val make_get_notebook_metadata_output : ?notebook_metadata:Types.notebook_metadata -> unit -> Types.get_notebook_metadata_output
val make_get_notebook_metadata_input : notebook_id:Types.notebook_id -> unit -> Types.get_notebook_metadata_input
val make_get_named_query_output : ?named_query:Types.named_query -> unit -> Types.get_named_query_output
val make_get_named_query_input : named_query_id:Types.named_query_id -> unit -> Types.get_named_query_input
val make_get_database_output : ?database:Types.database -> unit -> Types.get_database_output
val make_get_database_input : ?work_group:Types.work_group_name -> database_name:Types.name_string -> catalog_name:Types.catalog_name_string -> unit -> Types.get_database_input
val make_data_catalog : ?error:Types.error_message -> ?connection_type:Types.connection_type -> ?status:Types.data_catalog_status -> ?parameters:Types.parameters_map -> ?description:Types.description_string -> type_:Types.data_catalog_type -> name:Types.catalog_name_string -> unit -> Types.data_catalog
val make_get_data_catalog_output : ?data_catalog:Types.data_catalog -> unit -> Types.get_data_catalog_output
val make_get_data_catalog_input : ?work_group:Types.work_group_name -> name:Types.catalog_name_string -> unit -> Types.get_data_catalog_input
val make_get_capacity_reservation_output : capacity_reservation:Types.capacity_reservation -> unit -> Types.get_capacity_reservation_output
val make_get_capacity_reservation_input : name:Types.capacity_reservation_name -> unit -> Types.get_capacity_reservation_input
val make_capacity_assignment_configuration : ?capacity_assignments:Types.capacity_assignments_list -> ?capacity_reservation_name:Types.capacity_reservation_name -> unit -> Types.capacity_assignment_configuration
val make_get_capacity_assignment_configuration_output : capacity_assignment_configuration:Types.capacity_assignment_configuration -> unit -> Types.get_capacity_assignment_configuration_output
val make_get_capacity_assignment_configuration_input : capacity_reservation_name:Types.capacity_reservation_name -> unit -> Types.get_capacity_assignment_configuration_input
val make_calculation_statistics : ?progress:Types.description_string -> ?dpu_execution_in_millis:Types.long -> unit -> Types.calculation_statistics
val make_get_calculation_execution_status_response : ?statistics:Types.calculation_statistics -> ?status:Types.calculation_status -> unit -> Types.get_calculation_execution_status_response
val make_get_calculation_execution_status_request : calculation_execution_id:Types.calculation_execution_id -> unit -> Types.get_calculation_execution_status_request
val make_get_calculation_execution_response : ?result_:Types.calculation_result -> ?statistics:Types.calculation_statistics -> ?status:Types.calculation_status -> ?working_directory:Types.s3_uri -> ?description:Types.description_string -> ?session_id:Types.session_id -> ?calculation_execution_id:Types.calculation_execution_id -> unit -> Types.get_calculation_execution_response
val make_get_calculation_execution_request : calculation_execution_id:Types.calculation_execution_id -> unit -> Types.get_calculation_execution_request
val make_get_calculation_execution_code_response : ?code_block:Types.code_block -> unit -> Types.get_calculation_execution_code_response
val make_get_calculation_execution_code_request : calculation_execution_id:Types.calculation_execution_id -> unit -> Types.get_calculation_execution_code_request
val make_export_notebook_output : ?payload:Types.payload -> ?notebook_metadata:Types.notebook_metadata -> unit -> Types.export_notebook_output
val make_export_notebook_input : notebook_id:Types.notebook_id -> unit -> Types.export_notebook_input
val make_delete_work_group_output : unit -> unit
val make_delete_work_group_input : ?recursive_delete_option:Types.boxed_boolean -> work_group:Types.work_group_name -> unit -> Types.delete_work_group_input
val make_delete_prepared_statement_output : unit -> unit
val make_delete_prepared_statement_input : work_group:Types.work_group_name -> statement_name:Types.statement_name -> unit -> Types.delete_prepared_statement_input
val make_delete_notebook_output : unit -> unit
val make_delete_notebook_input : notebook_id:Types.notebook_id -> unit -> Types.delete_notebook_input
val make_delete_named_query_output : unit -> unit
val make_delete_named_query_input : named_query_id:Types.named_query_id -> unit -> Types.delete_named_query_input
val make_delete_data_catalog_output : ?data_catalog:Types.data_catalog -> unit -> Types.delete_data_catalog_output
val make_delete_data_catalog_input : ?delete_catalog_only:Types.boolean_ -> name:Types.catalog_name_string -> unit -> Types.delete_data_catalog_input
val make_delete_capacity_reservation_output : unit -> unit
val make_delete_capacity_reservation_input : name:Types.capacity_reservation_name -> unit -> Types.delete_capacity_reservation_input
val make_create_work_group_output : unit -> unit
val make_create_work_group_input : ?tags:Types.tag_list -> ?description:Types.work_group_description_string -> ?configuration:Types.work_group_configuration -> name:Types.work_group_name -> unit -> Types.create_work_group_input
val make_create_presigned_notebook_url_response : auth_token_expiration_time:Types.long -> auth_token:Types.auth_token -> notebook_url:Types.string_ -> unit -> Types.create_presigned_notebook_url_response
val make_create_presigned_notebook_url_request : session_id:Types.session_id -> unit -> Types.create_presigned_notebook_url_request
val make_create_prepared_statement_output : unit -> unit
val make_create_prepared_statement_input : ?description:Types.description_string -> query_statement:Types.query_string -> work_group:Types.work_group_name -> statement_name:Types.statement_name -> unit -> Types.create_prepared_statement_input
val make_create_notebook_output : ?notebook_id:Types.notebook_id -> unit -> Types.create_notebook_output
val make_create_notebook_input : ?client_request_token:Types.client_request_token -> name:Types.notebook_name -> work_group:Types.work_group_name -> unit -> Types.create_notebook_input
val make_create_named_query_output : ?named_query_id:Types.named_query_id -> unit -> Types.create_named_query_output
val make_create_named_query_input : ?work_group:Types.work_group_name -> ?client_request_token:Types.idempotency_token -> ?description:Types.description_string -> query_string:Types.query_string -> database:Types.database_string -> name:Types.name_string -> unit -> Types.create_named_query_input
val make_create_data_catalog_output : ?data_catalog:Types.data_catalog -> unit -> Types.create_data_catalog_output
val make_create_data_catalog_input : ?tags:Types.tag_list -> ?parameters:Types.parameters_map -> ?description:Types.description_string -> type_:Types.data_catalog_type -> name:Types.catalog_name_string -> unit -> Types.create_data_catalog_input
val make_create_capacity_reservation_output : unit -> unit
val make_create_capacity_reservation_input : ?tags:Types.tag_list -> name:Types.capacity_reservation_name -> target_dpus:Types.target_dpus_integer -> unit -> Types.create_capacity_reservation_input
val make_cancel_capacity_reservation_output : unit -> unit
val make_cancel_capacity_reservation_input : name:Types.capacity_reservation_name -> unit -> Types.cancel_capacity_reservation_input
val make_batch_get_query_execution_output : ?unprocessed_query_execution_ids:Types.unprocessed_query_execution_id_list -> ?query_executions:Types.query_execution_list -> unit -> Types.batch_get_query_execution_output
val make_batch_get_query_execution_input : query_execution_ids:Types.query_execution_id_list -> unit -> Types.batch_get_query_execution_input
val make_batch_get_prepared_statement_output : ?unprocessed_prepared_statement_names: Types.unprocessed_prepared_statement_name_list -> ?prepared_statements:Types.prepared_statement_details_list -> unit -> Types.batch_get_prepared_statement_output
val make_batch_get_prepared_statement_input : work_group:Types.work_group_name -> prepared_statement_names:Types.prepared_statement_name_list -> unit -> Types.batch_get_prepared_statement_input
val make_batch_get_named_query_output : ?unprocessed_named_query_ids:Types.unprocessed_named_query_id_list -> ?named_queries:Types.named_query_list -> unit -> Types.batch_get_named_query_output
val make_batch_get_named_query_input : named_query_ids:Types.named_query_id_list -> unit -> Types.batch_get_named_query_input

Operations

module BatchGetNamedQuery : sig ... end

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.

module BatchGetPreparedStatement : sig ... 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.

module BatchGetQueryExecution : sig ... 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.

module CancelCapacityReservation : sig ... 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.

module CreateCapacityReservation : sig ... end

Creates a capacity reservation with the specified name and number of requested data processing units.

module CreateDataCatalog : sig ... 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.

module CreateNamedQuery : sig ... end

Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

module CreateNotebook : sig ... 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.

module CreatePreparedStatement : sig ... end

Creates a prepared statement for use with SQL queries in Athena.

module CreatePresignedNotebookUrl : sig ... 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.

module CreateWorkGroup : sig ... end

Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

module DeleteCapacityReservation : sig ... 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.

module DeleteDataCatalog : sig ... end

Deletes a data catalog.

module DeleteNamedQuery : sig ... end

Deletes the named query if you have access to the workgroup in which the query was saved.

module DeleteNotebook : sig ... end

Deletes the specified notebook.

module DeletePreparedStatement : sig ... end

Deletes the prepared statement with the specified name from the specified workgroup.

module DeleteWorkGroup : sig ... end

Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

module ExportNotebook : sig ... end

Exports the specified notebook and its metadata.

module GetCalculationExecution : sig ... end

Describes a previously submitted calculation execution.

module GetCalculationExecutionCode : sig ... end

Retrieves the unencrypted code that was executed for the calculation.

module GetCalculationExecutionStatus : sig ... end

Gets the status of a current calculation.

Gets the capacity assignment configuration for a capacity reservation, if one exists.

module GetCapacityReservation : sig ... end

Returns information about the capacity reservation with the specified name.

module GetDataCatalog : sig ... end

Returns the specified data catalog.

module GetDatabase : sig ... end

Returns a database object for the specified database and data catalog.

module GetNamedQuery : sig ... end

Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

module GetNotebookMetadata : sig ... end

Retrieves notebook metadata for the specified notebook ID.

module GetPreparedStatement : sig ... end

Retrieves the prepared statement with the specified name from the specified workgroup.

module GetQueryExecution : sig ... 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.

module GetQueryResults : sig ... 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 in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

module GetQueryRuntimeStatistics : sig ... 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 or, in some cases, may not be returned. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.

module GetResourceDashboard : sig ... end

Gets the Live UI/Persistence UI for a session.

module GetSession : sig ... end

Gets the full details of a previously created session, including the session status and configuration.

module GetSessionEndpoint : sig ... end

Gets a connection endpoint and authentication token for a given session Id.

module GetSessionStatus : sig ... end

Gets the current status of a session.

module GetTableMetadata : sig ... end

Returns table metadata for the specified catalog, database, and table.

module GetWorkGroup : sig ... end

Returns information about the workgroup with the specified name.

module ImportNotebook : sig ... 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.

module ListApplicationDPUSizes : sig ... end

Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).

module ListCalculationExecutions : sig ... end

Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

module ListCapacityReservations : sig ... end

Lists the capacity reservations for the current account.

module ListDataCatalogs : sig ... end

Lists the data catalogs in the current Amazon Web Services account.

module ListDatabases : sig ... end

Lists the databases in the specified data catalog.

module ListEngineVersions : sig ... end

Returns a list of engine versions that are available to choose from, including the Auto option.

module ListExecutors : sig ... 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.

module ListNamedQueries : sig ... 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.

module ListNotebookMetadata : sig ... end

Displays the notebook files for the specified workgroup in paginated format.

module ListNotebookSessions : sig ... 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.

module ListPreparedStatements : sig ... end

Lists the prepared statements in the specified workgroup.

module ListQueryExecutions : sig ... 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.

module ListSessions : sig ... 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.

module ListTableMetadata : sig ... end

Lists the metadata for the tables in the specified data catalog database.

module ListTagsForResource : sig ... end

Lists the tags associated with an Athena resource.

module ListWorkGroups : sig ... end

Lists available workgroups for the account.

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.

module StartCalculationExecution : sig ... end

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

module StartQueryExecution : sig ... 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 in the Amazon Athena User Guide.

module StartSession : sig ... end

Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

module StopCalculationExecution : sig ... 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.

module StopQueryExecution : sig ... end

Stops a query execution. Requires you to have access to the workgroup in which the query ran.

module TagResource : sig ... 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. 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.

module TerminateSession : sig ... 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.

module UntagResource : sig ... end

Removes one or more tags from an Athena resource.

module UpdateCapacityReservation : sig ... end

Updates the number of requested data processing units for the capacity reservation with the specified name.

module UpdateDataCatalog : sig ... end

Updates the data catalog that has the specified name.

module UpdateNamedQuery : sig ... end

Updates a NamedQuery object. The database or workgroup cannot be updated.

module UpdateNotebook : sig ... end

Updates the contents of a Spark notebook.

module UpdateNotebookMetadata : sig ... end

Updates the metadata for a notebook.

module UpdatePreparedStatement : sig ... end

Updates a prepared statement.

module UpdateWorkGroup : sig ... end
module Json_serializers : sig ... end
module Json_deserializers : sig ... end