Module Smaws_Client_Athena.Types

type nonrec datum_string = string
type nonrec datum = {
  1. var_char_value : datum_string option;
    (*

    The value of the datum.

    *)
}

A piece of data (a field in the table).

type nonrec datum_list = datum list
type nonrec work_group_name = string
type nonrec work_group_state =
  1. | DISABLED
  2. | ENABLED
type nonrec work_group_description_string = string
type nonrec date = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec name_string = string
type nonrec engine_version = {
  1. effective_engine_version : name_string option;
    (*

    Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

    *)
  2. selected_engine_version : name_string option;
    (*

    The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

    *)
}

The Athena engine version for running queries, or the PySpark engine version for running sessions.

type nonrec identity_center_application_arn = string
type nonrec work_group_summary = {
  1. identity_center_application_arn : identity_center_application_arn option;
    (*

    The ARN of the IAM Identity Center enabled application associated with the workgroup.

    *)
  2. engine_version : engine_version option;
    (*

    The engine version setting for all queries on the workgroup. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

    *)
  3. creation_time : date option;
    (*

    The workgroup creation date and time.

    *)
  4. description : work_group_description_string option;
    (*

    The workgroup description.

    *)
  5. state : work_group_state option;
    (*

    The state of the workgroup.

    *)
  6. name : work_group_name option;
    (*

    The name of the workgroup.

    *)
}

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.

type nonrec work_groups_list = work_group_summary list
type nonrec work_group_names_list = work_group_name list
type nonrec boxed_boolean = bool
type nonrec result_output_location = string
type nonrec encryption_option =
  1. | CSE_KMS
  2. | SSE_KMS
  3. | SSE_S3
type nonrec string_ = string
type nonrec encryption_configuration = {
  1. kms_key : string_ option;
    (*

    For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

    *)
  2. encryption_option : encryption_option;
    (*

    Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.

    If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

    *)
}

If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.

type nonrec aws_account_id = string
type nonrec s3_acl_option =
  1. | BUCKET_OWNER_FULL_CONTROL
type nonrec acl_configuration = {
  1. s3_acl_option : s3_acl_option;
    (*

    The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.

    *)
}

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. When Athena stores query results in Amazon S3, the canned ACL is set with the x-amz-acl request header. For more information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User Guide.

type nonrec result_configuration_updates = {
  1. remove_acl_configuration : boxed_boolean option;
    (*

    If set to true, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to false or not set, and a value is present in the AclConfiguration of ResultConfigurationUpdates, the AclConfiguration in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

    *)
  2. acl_configuration : acl_configuration option;
    (*

    The ACL configuration for the query results.

    *)
  3. remove_expected_bucket_owner : boxed_boolean option;
    (*

    If set to "true", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to "false" or not set, and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

    *)
  4. expected_bucket_owner : aws_account_id option;
    (*

    The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

    If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

    *)
  5. remove_encryption_configuration : boxed_boolean option;
    (*

    If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

    *)
  6. encryption_configuration : encryption_configuration option;
    (*

    The encryption configuration for query and calculation results.

    *)
  7. remove_output_location : boxed_boolean option;
    (*

    If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

    *)
  8. output_location : result_output_location option;
    (*

    The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

    *)
}

The information about the updates in the query results, such as output location and encryption configuration for the query results.

type nonrec kms_key = string
type nonrec managed_query_results_encryption_configuration = {
  1. kms_key : kms_key;
    (*

    The ARN of an KMS key for encrypting managed query results.

    *)
}

If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

type nonrec managed_query_results_configuration_updates = {
  1. remove_encryption_configuration : boxed_boolean option;
    (*

    If set to true, it removes workgroup from Athena owned storage. The existing query results are cleaned up after 24hrs. You must provide query results in location specified under ResultConfiguration$OutputLocation.

    *)
  2. encryption_configuration : managed_query_results_encryption_configuration option;
    (*

    If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

    *)
  3. enabled : boxed_boolean option;
    (*

    If set to true, specifies that Athena manages query results in Athena owned storage.

    *)
}

Updates the configuration for managed query results.

type nonrec bytes_scanned_cutoff_value = Smaws_Lib.CoreTypes.Int64.t
type nonrec role_arn = string
type nonrec customer_content_encryption_configuration = {
  1. kms_key : kms_key;
    (*

    The customer managed KMS key that is used to encrypt the user's data stores in Athena.

    *)
}

Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

type nonrec authentication_type =
  1. | DIRECTORY_IDENTITY
type nonrec query_results_s3_access_grants_configuration = {
  1. authentication_type : authentication_type;
    (*

    The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

    *)
  2. create_user_level_prefix : boxed_boolean option;
    (*

    When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

    *)
  3. enable_s3_access_grants : boxed_boolean;
    (*

    Specifies whether Amazon S3 access grants are enabled for query results.

    *)
}

Specifies whether Amazon S3 access grants are enabled for query results.

type nonrec log_group_name = string
type nonrec log_stream_name_prefix = string
type nonrec log_type_value = string
type nonrec log_type_values_list = log_type_value list
type nonrec log_type_key = string
type nonrec log_types_map = (log_type_key * log_type_values_list) list
type nonrec cloud_watch_logging_configuration = {
  1. log_types : log_types_map option;
    (*

    The types of logs that you want to publish to CloudWatch.

    *)
  2. log_stream_name_prefix : log_stream_name_prefix option;
    (*

    Prefix for the CloudWatch log stream name.

    *)
  3. log_group : log_group_name option;
    (*

    The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

    *)
  4. enabled : boxed_boolean;
    (*

    Enables CloudWatch logging.

    *)
}

Configuration settings for delivering logs to Amazon CloudWatch log groups.

type nonrec managed_logging_configuration = {
  1. kms_key : kms_key option;
    (*

    The KMS key ARN to encrypt the logs stored in managed log persistence.

    *)
  2. enabled : boxed_boolean;
    (*

    Enables mamanged log persistence.

    *)
}

Configuration settings for delivering logs to Amazon S3 buckets.

type nonrec s3_output_location = string
type nonrec s3_logging_configuration = {
  1. log_location : s3_output_location option;
    (*

    The Amazon S3 destination URI for log publishing.

    *)
  2. kms_key : kms_key option;
    (*

    The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

    *)
  3. enabled : boxed_boolean;
    (*

    Enables S3 log delivery.

    *)
}

Configuration settings for delivering logs to Amazon S3 buckets.

type nonrec monitoring_configuration = {
  1. s3_logging_configuration : s3_logging_configuration option;
    (*

    Configuration settings for delivering logs to Amazon S3 buckets.

    *)
  2. managed_logging_configuration : managed_logging_configuration option;
    (*

    Configuration settings for managed log persistence.

    *)
  3. cloud_watch_logging_configuration : cloud_watch_logging_configuration option;
    (*

    Configuration settings for delivering logs to Amazon CloudWatch log groups.

    *)
}

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

type nonrec coordinator_dpu_size = int
type nonrec max_concurrent_dpus = int
type nonrec default_executor_dpu_size = int
type nonrec parameters_map_value = string
type nonrec key_string = string
type nonrec parameters_map = (key_string * parameters_map_value) list
type nonrec classification = {
  1. properties : parameters_map option;
    (*

    A set of properties specified within a configuration classification.

    *)
  2. name : name_string option;
    (*

    The name of the configuration classification.

    *)
}

A classification refers to a set of specific configurations.

type nonrec classification_list = classification list
type nonrec engine_configuration = {
  1. classifications : classification_list option;
    (*

    The configuration classifications that can be specified for the engine.

    *)
  2. spark_properties : parameters_map option;
    (*

    Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

    *)
  3. additional_configs : parameters_map option;
    (*

    Contains additional notebook engine

    MAP

    parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.

    *)
  4. default_executor_dpu_size : default_executor_dpu_size option;
    (*

    The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.

    *)
  5. max_concurrent_dpus : max_concurrent_dpus option;
    (*

    The maximum number of DPUs that can run concurrently.

    *)
  6. coordinator_dpu_size : coordinator_dpu_size option;
    (*

    The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.

    *)
}

The engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity. If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).

To specify DPU values for PC queries the WG containing EngineConfiguration should have the following values: The name of the Classifications should be athena-query-engine-properties, with the only allowed properties as max-dpu-count and min-dpu-count.

type nonrec work_group_configuration_updates = {
  1. engine_configuration : engine_configuration option;
  2. monitoring_configuration : monitoring_configuration option;
    (*

    Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

    *)
  3. query_results_s3_access_grants_configuration : query_results_s3_access_grants_configuration option;
    (*

    Specifies whether Amazon S3 access grants are enabled for query results.

    *)
  4. enable_minimum_encryption_configuration : boxed_boolean option;
    (*

    Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

    The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

    *)
  5. customer_content_encryption_configuration : customer_content_encryption_configuration option;
  6. execution_role : role_arn option;
    (*

    The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

    *)
  7. additional_configuration : name_string option;
    (*

    Contains a user defined string in JSON format for a Spark-enabled workgroup.

    *)
  8. remove_customer_content_encryption_configuration : boxed_boolean option;
    (*

    Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

    *)
  9. engine_version : engine_version option;
    (*

    The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

    *)
  10. requester_pays_enabled : boxed_boolean option;
    (*

    If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

    *)
  11. remove_bytes_scanned_cutoff_per_query : boxed_boolean option;
    (*

    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

    *)
  12. bytes_scanned_cutoff_per_query : bytes_scanned_cutoff_value option;
    (*

    The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

    *)
  13. publish_cloud_watch_metrics_enabled : boxed_boolean option;
    (*

    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

    *)
  14. managed_query_results_configuration_updates : managed_query_results_configuration_updates option;
    (*

    Updates configuration information for managed query results in the workgroup.

    *)
  15. result_configuration_updates : result_configuration_updates option;
    (*

    The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

    *)
  16. enforce_work_group_configuration : boxed_boolean option;
    (*

    If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

    *)
}

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

type nonrec result_configuration = {
  1. acl_configuration : acl_configuration option;
    (*

    Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

    *)
  2. expected_bucket_owner : aws_account_id option;
    (*

    The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

    This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

    *)
  3. encryption_configuration : encryption_configuration option;
    (*

    If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

    *)
  4. output_location : result_output_location option;
    (*

    The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

    *)
}

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.

type nonrec boolean_ = bool
type nonrec managed_query_results_configuration = {
  1. encryption_configuration : managed_query_results_encryption_configuration option;
    (*

    If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

    *)
  2. enabled : boolean_;
    (*

    If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under ResultConfiguration$OutputLocation. The default is false. A workgroup cannot have the ResultConfiguration$OutputLocation parameter when you set this field to true.

    *)
}

The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

type nonrec identity_center_instance_arn = string
type nonrec identity_center_configuration = {
  1. identity_center_instance_arn : identity_center_instance_arn option;
    (*

    The IAM Identity Center instance ARN that the workgroup associates to.

    *)
  2. enable_identity_center : boxed_boolean option;
    (*

    Specifies whether the workgroup is IAM Identity Center supported.

    *)
}

Specifies whether the workgroup is IAM Identity Center supported.

type nonrec work_group_configuration = {
  1. query_results_s3_access_grants_configuration : query_results_s3_access_grants_configuration option;
    (*

    Specifies whether Amazon S3 access grants are enabled for query results.

    *)
  2. identity_center_configuration : identity_center_configuration option;
    (*

    Specifies whether the workgroup is IAM Identity Center supported.

    *)
  3. enable_minimum_encryption_configuration : boxed_boolean option;
    (*

    Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.

    The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

    *)
  4. customer_content_encryption_configuration : customer_content_encryption_configuration option;
    (*

    Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

    *)
  5. engine_configuration : engine_configuration option;
  6. monitoring_configuration : monitoring_configuration option;
    (*

    Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

    *)
  7. execution_role : role_arn option;
    (*

    The ARN of the execution role used to access user resources for Spark sessions and IAM Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.

    *)
  8. additional_configuration : name_string option;
    (*

    Specifies a user defined JSON string that is passed to the notebook engine.

    *)
  9. engine_version : engine_version option;
    (*

    The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

    *)
  10. requester_pays_enabled : boxed_boolean option;
    (*

    If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

    *)
  11. bytes_scanned_cutoff_per_query : bytes_scanned_cutoff_value option;
    (*

    The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

    *)
  12. publish_cloud_watch_metrics_enabled : boxed_boolean option;
    (*

    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

    *)
  13. enforce_work_group_configuration : boxed_boolean option;
    (*

    If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. This property is not required for Apache Spark enabled workgroups. For more information, see Workgroup Settings Override Client-Side Settings.

    *)
  14. managed_query_results_configuration : managed_query_results_configuration option;
    (*

    The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

    *)
  15. result_configuration : result_configuration option;
    (*

    The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided.

    *)
}

The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query and calculation results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

type nonrec work_group = {
  1. identity_center_application_arn : identity_center_application_arn option;
    (*

    The ARN of the IAM Identity Center enabled application associated with the workgroup.

    *)
  2. creation_time : date option;
    (*

    The date and time the workgroup was created.

    *)
  3. description : work_group_description_string option;
    (*

    The workgroup description.

    *)
  4. configuration : work_group_configuration option;
    (*

    The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

    *)
  5. state : work_group_state option;
    (*

    The state of the workgroup: ENABLED or DISABLED.

    *)
  6. name : work_group_name;
    (*

    The workgroup name.

    *)
}

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

type nonrec update_work_group_output = unit
type nonrec update_work_group_input = {
  1. state : work_group_state option;
    (*

    The workgroup state that will be updated for the given workgroup.

    *)
  2. configuration_updates : work_group_configuration_updates option;
    (*

    Contains configuration updates for an Athena SQL workgroup.

    *)
  3. description : work_group_description_string option;
    (*

    The workgroup description.

    *)
  4. work_group : work_group_name;
    (*

    The specified workgroup that will be updated.

    *)
}
type nonrec error_code = string
type nonrec error_message = string
type nonrec invalid_request_exception = {
  1. message : error_message option;
  2. athena_error_code : error_code option;
}

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

type nonrec internal_server_exception = {
  1. message : error_message option;
}

Indicates a platform issue, which may be due to a transient condition or outage.

type nonrec update_prepared_statement_output = unit
type nonrec statement_name = string
type nonrec query_string = string
type nonrec description_string = string
type nonrec update_prepared_statement_input = {
  1. description : description_string option;
    (*

    The description of the prepared statement.

    *)
  2. query_statement : query_string;
    (*

    The query string for the prepared statement.

    *)
  3. work_group : work_group_name;
    (*

    The workgroup for the prepared statement.

    *)
  4. statement_name : statement_name;
    (*

    The name of the prepared statement.

    *)
}
type nonrec amazon_resource_name = string
type nonrec resource_not_found_exception = {
  1. resource_name : amazon_resource_name option;
    (*

    The name of the Amazon resource.

    *)
  2. message : error_message option;
}

A resource, such as a workgroup, was not found.

type nonrec update_notebook_output = unit
type nonrec update_notebook_metadata_output = unit
type nonrec notebook_id = string
type nonrec client_request_token = string
type nonrec notebook_name = string
type nonrec update_notebook_metadata_input = {
  1. name : notebook_name;
    (*

    The name to update the notebook to.

    *)
  2. client_request_token : client_request_token option;
    (*

    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.

    *)
  3. notebook_id : notebook_id;
    (*

    The ID of the notebook to update the metadata for.

    *)
}
type nonrec throttle_reason =
  1. | CONCURRENT_QUERY_LIMIT_EXCEEDED

The reason for the query throttling, for example, when it exceeds the concurrent query limit.

type nonrec too_many_requests_exception = {
  1. reason : throttle_reason option;
  2. message : error_message option;
}

Indicates that the request was throttled.

type nonrec payload = string
type nonrec notebook_type =
  1. | IPYNB
type nonrec session_id = string
type nonrec update_notebook_input = {
  1. client_request_token : client_request_token option;
    (*

    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.

    *)
  2. session_id : session_id option;
    (*

    The active notebook session ID. Required if the notebook has an active session.

    *)
  3. type_ : notebook_type;
    (*

    The notebook content type. Currently, the only valid type is IPYNB.

    *)
  4. payload : payload;
    (*

    The updated content for the notebook.

    *)
  5. notebook_id : notebook_id;
    (*

    The ID of the notebook to update.

    *)
}
type nonrec update_named_query_output = unit
type nonrec named_query_id = string
type nonrec named_query_description_string = string
type nonrec update_named_query_input = {
  1. query_string : query_string;
    (*

    The contents of the query with all query statements.

    *)
  2. description : named_query_description_string option;
    (*

    The query description.

    *)
  3. name : name_string;
    (*

    The name of the query.

    *)
  4. named_query_id : named_query_id;
    (*

    The unique identifier (UUID) of the query.

    *)
}
type nonrec update_data_catalog_output = unit
type nonrec catalog_name_string = string
type nonrec data_catalog_type =
  1. | FEDERATED
  2. | HIVE
  3. | GLUE
  4. | LAMBDA
type nonrec update_data_catalog_input = {
  1. parameters : parameters_map option;
    (*

    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={i lambda_arn}, sdk-version={i 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={i lambda_arn}, record-function={i 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={i lambda_arn}
    *)
  2. description : description_string option;
    (*

    New or modified text that describes the data catalog.

    *)
  3. type_ : data_catalog_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.

    *)
  4. name : catalog_name_string;
    (*

    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.

    *)
}
type nonrec update_capacity_reservation_output = unit
type nonrec target_dpus_integer = int
type nonrec capacity_reservation_name = string
type nonrec update_capacity_reservation_input = {
  1. name : capacity_reservation_name;
    (*

    The name of the capacity reservation.

    *)
  2. target_dpus : target_dpus_integer;
    (*

    The new number of requested data processing units.

    *)
}
type nonrec untag_resource_output = unit
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_input = {
  1. tag_keys : tag_key_list;
    (*

    A comma-separated list of one or more tag keys whose tags are to be removed from the specified resource.

    *)
  2. resource_ar_n : amazon_resource_name;
    (*

    Specifies the ARN of the resource from which tags are to be removed.

    *)
}
type nonrec query_execution_id = string
type nonrec unprocessed_query_execution_id = {
  1. error_message : error_message option;
    (*

    The error message returned when the query execution failed to process, if applicable.

    *)
  2. error_code : error_code option;
    (*

    The error code returned when the query execution failed to process, if applicable.

    *)
  3. query_execution_id : query_execution_id option;
    (*

    The unique identifier of the query execution.

    *)
}

Describes a query execution that failed to process.

type nonrec unprocessed_query_execution_id_list = unprocessed_query_execution_id list
type nonrec unprocessed_prepared_statement_name = {
  1. error_message : error_message option;
    (*

    The error message containing the reason why the prepared statement could not be returned. The following error messages are possible:

    • INVALID_INPUT - The name of the prepared statement that was provided is not valid (for example, the name is too long).
    • STATEMENT_NOT_FOUND - A prepared statement with the name provided could not be found.
    • UNAUTHORIZED - The requester does not have permission to access the workgroup that contains the prepared statement.
    *)
  2. error_code : error_code option;
    (*

    The error code returned when the request for the prepared statement failed.

    *)
  3. statement_name : statement_name option;
    (*

    The name of a prepared statement that could not be returned due to an error.

    *)
}

The name of a prepared statement that could not be returned.

type nonrec unprocessed_prepared_statement_name_list = unprocessed_prepared_statement_name list
type nonrec unprocessed_named_query_id = {
  1. error_message : error_message option;
    (*

    The error message returned when the processing request for the named query failed, if applicable.

    *)
  2. error_code : error_code option;
    (*

    The error code returned when the processing request for the named query failed, if applicable.

    *)
  3. named_query_id : named_query_id option;
    (*

    The unique identifier of the named query.

    *)
}

Information about a named query ID that could not be processed.

type nonrec unprocessed_named_query_id_list = unprocessed_named_query_id list
type nonrec type_string = string
type nonrec token = string
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec session_state =
  1. | FAILED
  2. | DEGRADED
  3. | TERMINATED
  4. | TERMINATING
  5. | BUSY
  6. | IDLE
  7. | CREATED
  8. | CREATING
type nonrec terminate_session_response = {
  1. state : session_state option;
    (*

    The state of the session. 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.

    *)
}
type nonrec terminate_session_request = {
  1. session_id : session_id;
    (*

    The session ID.

    *)
}
type nonrec tag_value = string
type nonrec tag_resource_output = unit
type nonrec tag = {
  1. value : tag_value option;
    (*

    A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.

    *)
  2. key : tag_key option;
    (*

    A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.

    *)
}

A label that you assign to a resource. Athena resources include workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena resources 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.

type nonrec tag_list = tag list
type nonrec tag_resource_input = {
  1. tags : tag_list;
    (*

    A collection of one or more tags, separated by commas, to be added to an Athena resource.

    *)
  2. resource_ar_n : amazon_resource_name;
    (*

    Specifies the ARN of the Athena resource to which tags are to be added.

    *)
}
type nonrec table_type_string = string
type nonrec comment_string = string
type nonrec column = {
  1. comment : comment_string option;
    (*

    Optional information about the column.

    *)
  2. type_ : type_string option;
    (*

    The data type of the column.

    *)
  3. name : name_string;
    (*

    The name of the column.

    *)
}

Contains metadata for a column in a table.

type nonrec column_list = column list
type nonrec table_metadata = {
  1. parameters : parameters_map option;
    (*

    A set of custom key/value pairs for table properties.

    *)
  2. partition_keys : column_list option;
    (*

    A list of the partition keys in the table.

    *)
  3. columns : column_list option;
    (*

    A list of the columns in the table.

    *)
  4. table_type : table_type_string option;
    (*

    The type of table. In Athena, only EXTERNAL_TABLE is supported.

    *)
  5. last_access_time : timestamp option;
    (*

    The last time the table was accessed.

    *)
  6. create_time : timestamp option;
    (*

    The time that the table was created.

    *)
  7. name : name_string;
    (*

    The name of the table.

    *)
}

Contains metadata for a table.

type nonrec table_metadata_list = table_metadata list
type nonrec integer = int
type nonrec supported_dpu_size_list = integer list
type nonrec string_list = string_ list
type nonrec stop_query_execution_output = unit
type nonrec stop_query_execution_input = {
  1. query_execution_id : query_execution_id;
    (*

    The unique ID of the query execution to stop.

    *)
}
type nonrec calculation_execution_state =
  1. | FAILED
  2. | COMPLETED
  3. | CANCELED
  4. | CANCELING
  5. | RUNNING
  6. | QUEUED
  7. | CREATED
  8. | CREATING
type nonrec stop_calculation_execution_response = {
  1. state : calculation_execution_state option;
    (*

    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.

    *)
}
type nonrec calculation_execution_id = string
type nonrec stop_calculation_execution_request = {
  1. calculation_execution_id : calculation_execution_id;
    (*

    The calculation execution UUID.

    *)
}
type nonrec statement_type =
  1. | UTILITY
  2. | DML
  3. | DDL
type nonrec start_session_response = {
  1. state : session_state option;
    (*

    The state of the session. 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.

    *)
  2. session_id : session_id option;
    (*

    The session ID.

    *)
}
type nonrec session_idle_timeout_in_minutes = int
type nonrec idempotency_token = string
type nonrec start_session_request = {
  1. copy_work_group_tags : boxed_boolean option;
    (*

    Copies the tags from the Workgroup to the Session when.

    *)
  2. tags : tag_list option;
    (*

    A list of comma separated tags to add to the session that is created.

    *)
  3. client_request_token : idempotency_token option;
    (*

    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.

    *)
  4. session_idle_timeout_in_minutes : session_idle_timeout_in_minutes option;
    (*

    The idle timeout in minutes for the session.

    *)
  5. notebook_version : name_string option;
    (*

    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.

    *)
  6. monitoring_configuration : monitoring_configuration option;
    (*

    Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

    *)
  7. execution_role : role_arn option;
    (*

    The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

    *)
  8. engine_configuration : engine_configuration;
    (*

    Contains engine data processing unit (DPU) configuration settings and parameter mappings.

    *)
  9. work_group : work_group_name;
    (*

    The workgroup to which the session belongs.

    *)
  10. description : description_string option;
    (*

    The session description.

    *)
}
type nonrec session_already_exists_exception = {
  1. message : error_message option;
}

The specified session already exists.

type nonrec start_query_execution_output = {
  1. query_execution_id : query_execution_id option;
    (*

    The unique ID of the query that ran as a result of this request.

    *)
}
type nonrec database_string = string
type nonrec query_execution_context = {
  1. catalog : catalog_name_string option;
    (*

    The name of the data catalog used in the query execution.

    *)
  2. database : database_string option;
    (*

    The name of the database used in the query execution. The database must exist in the catalog.

    *)
}

The database and data catalog context in which the query execution occurs.

type nonrec execution_parameter = string
type nonrec execution_parameters = execution_parameter list
type nonrec age = int
type nonrec result_reuse_by_age_configuration = {
  1. max_age_in_minutes : age option;
    (*

    Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.

    *)
  2. enabled : boolean_;
    (*

    True if previous query results can be reused when the query is run; otherwise, false. The default is false.

    *)
}

Specifies whether previous query results are reused, and if so, their maximum age.

type nonrec result_reuse_configuration = {
  1. result_reuse_by_age_configuration : result_reuse_by_age_configuration option;
    (*

    Specifies whether previous query results are reused, and if so, their maximum age.

    *)
}

Specifies the query result reuse behavior for the query.

type nonrec start_query_execution_input = {
  1. engine_configuration : engine_configuration option;
    (*

    The engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity. If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).

    To specify minimum and maximum DPU values for Capacity Reservations queries, the workgroup containing EngineConfiguration should have the following values: The name of the Classifications should be athena-query-engine-properties, with the only allowed properties as max-dpu-count and min-dpu-count.

    *)
  2. result_reuse_configuration : result_reuse_configuration option;
    (*

    Specifies the query result reuse behavior for the query.

    *)
  3. execution_parameters : execution_parameters option;
    (*

    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.

    *)
  4. work_group : work_group_name option;
    (*

    The name of the workgroup in which the query is being started.

    *)
  5. result_configuration : result_configuration option;
    (*

    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.

    *)
  6. query_execution_context : query_execution_context option;
    (*

    The database within which the query executes.

    *)
  7. client_request_token : idempotency_token option;
    (*

    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.

    *)
  8. query_string : query_string;
    (*

    The SQL query statements to be executed.

    *)
}
type nonrec start_calculation_execution_response = {
  1. state : calculation_execution_state option;
    (*

    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.

    *)
  2. calculation_execution_id : calculation_execution_id option;
    (*

    The calculation execution UUID.

    *)
}
type nonrec code_block = string
type nonrec calculation_configuration = {
  1. code_block : code_block option;
    (*

    A string that contains the code for the calculation.

    *)
}

Contains configuration information for the calculation.

type nonrec start_calculation_execution_request = {
  1. client_request_token : idempotency_token option;
    (*

    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.

    *)
  2. code_block : code_block option;
    (*

    A string that contains the code of the calculation. Use this parameter instead of CalculationConfiguration$CodeBlock, which is deprecated.

    *)
  3. calculation_configuration : calculation_configuration option;
    (*

    Contains configuration information for the calculation.

    *)
  4. description : description_string option;
    (*

    A description of the calculation.

    *)
  5. session_id : session_id;
    (*

    The session ID.

    *)
}
type nonrec session_status = {
  1. state_change_reason : description_string option;
    (*

    The reason for the session state change (for example, canceled because the session was terminated).

    *)
  2. state : session_state option;
    (*

    The state of the session. 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.

    *)
  3. idle_since_date_time : date option;
    (*

    The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

    *)
  4. end_date_time : date option;
    (*

    The date and time that the session ended.

    *)
  5. last_modified_date_time : date option;
    (*

    The most recent date and time that the session was modified.

    *)
  6. start_date_time : date option;
    (*

    The date and time that the session started.

    *)
}

Contains information about the status of a session.

type nonrec session_summary = {
  1. status : session_status option;
    (*

    Contains information about the session status.

    *)
  2. notebook_version : name_string option;
    (*

    The notebook version.

    *)
  3. engine_version : engine_version option;
    (*

    The engine version used by the session (for example, PySpark engine version 3).

    *)
  4. description : description_string option;
    (*

    The session description.

    *)
  5. session_id : session_id option;
    (*

    The session ID.

    *)
}

Contains summary information about a session.

type nonrec sessions_list = session_summary list
type nonrec long = Smaws_Lib.CoreTypes.Int64.t
type nonrec session_statistics = {
  1. dpu_execution_in_millis : long option;
    (*

    The data processing unit execution time for a session in milliseconds.

    *)
}

Contains statistics for a session.

type nonrec session_manager_token = string
type nonrec session_configuration = {
  1. encryption_configuration : encryption_configuration option;
  2. session_idle_timeout_in_minutes : session_idle_timeout_in_minutes option;
    (*

    The idle timeout in seconds for the session.

    *)
  3. idle_timeout_seconds : long option;
    (*

    The idle timeout in seconds for the session.

    *)
  4. working_directory : result_output_location option;
    (*

    The Amazon S3 location that stores information for the notebook.

    *)
  5. execution_role : role_arn option;
    (*

    The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

    *)
}

Contains session configuration information.

type nonrec s3_uri = string
type nonrec row = {
  1. data : datum_list option;
    (*

    The data that populates a row in a query result table.

    *)
}

The rows that make up a query result table.

type nonrec row_list = row list
type nonrec column_nullable =
  1. | UNKNOWN
  2. | NULLABLE
  3. | NOT_NULL
type nonrec column_info = {
  1. case_sensitive : boolean_ option;
    (*

    Indicates whether values in the column are case-sensitive.

    *)
  2. nullable : column_nullable option;
    (*

    Unsupported constraint. This value always shows as UNKNOWN.

    *)
  3. scale : integer option;
    (*

    For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

    *)
  4. precision : integer option;
    (*

    For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

    *)
  5. type_ : string_;
    (*

    The data type of the column.

    *)
  6. label : string_ option;
    (*

    A column label.

    *)
  7. name : string_;
    (*

    The name of the column.

    *)
  8. table_name : string_ option;
    (*

    The table name for the query results.

    *)
  9. schema_name : string_ option;
    (*

    The schema name (database name) to which the query results belong.

    *)
  10. catalog_name : string_ option;
    (*

    The catalog to which the query results belong.

    *)
}

Information about the columns in a query execution result.

type nonrec column_info_list = column_info list
type nonrec result_set_metadata = {
  1. column_info : column_info_list option;
    (*

    Information about the columns returned in a query result metadata.

    *)
}

The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata object, use GetQueryResults.

type nonrec result_set = {
  1. result_set_metadata : result_set_metadata option;
    (*

    The metadata that describes the column structure and data types of a table of query results.

    *)
  2. rows : row_list option;
    (*

    The rows in the table.

    *)
}

The metadata and rows that make up a query result set. The metadata describes the column structure and data types. To return a ResultSet object, use GetQueryResults.

type nonrec result_reuse_information = {
  1. reused_previous_result : boolean_;
    (*

    True if a previous query result was reused; false if the result was generated from a new run of the query.

    *)
}

Contains information about whether the result of a previous query was reused.

type query_stage_plan_node = {
  1. remote_sources : string_list option;
    (*

    Source plan node IDs.

    *)
  2. children : query_stage_plan_nodes option;
    (*

    Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/

    *)
  3. identifier : string_ option;
    (*

    Information about the operation this query stage plan node is performing.

    *)
  4. name : string_ option;
    (*

    Name of the query stage plan that describes the operation this stage is performing as part of query execution.

    *)
}

Stage plan information such as name, identifier, sub plans, and remote sources.

and query_stage_plan_nodes = query_stage_plan_node list
type query_stage = {
  1. sub_stages : query_stages option;
    (*

    List of sub query stages that form this stage execution plan.

    *)
  2. query_stage_plan : query_stage_plan_node option;
    (*

    Stage plan information such as name, identifier, sub plans, and source stages.

    *)
  3. execution_time : long option;
    (*

    Time taken to execute this stage.

    *)
  4. input_rows : long option;
    (*

    The number of rows input into the stage for execution.

    *)
  5. input_bytes : long option;
    (*

    The number of bytes input into the stage for execution.

    *)
  6. output_rows : long option;
    (*

    The number of rows output from the stage after execution.

    *)
  7. output_bytes : long option;
    (*

    The number of bytes output from the stage after execution.

    *)
  8. state : string_ option;
    (*

    State of the stage after query execution.

    *)
  9. stage_id : long option;
    (*

    The identifier for a stage.

    *)
}

Stage statistics such as input and output rows and bytes, execution time and stage state. This information also includes substages and the query stage plan.

and query_stages = query_stage list
type nonrec query_runtime_statistics_timeline = {
  1. total_execution_time_in_millis : long option;
    (*

    The number of milliseconds that Athena took to run the query.

    *)
  2. service_processing_time_in_millis : long option;
    (*

    The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

    *)
  3. engine_execution_time_in_millis : long option;
    (*

    The number of milliseconds that the query took to execute.

    *)
  4. query_planning_time_in_millis : long option;
    (*

    The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

    *)
  5. service_pre_processing_time_in_millis : long option;
    (*

    The number of milliseconds that Athena spends on preprocessing before it submits the query to the engine.

    *)
  6. query_queue_time_in_millis : long option;
    (*

    The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

    *)
}

Timeline statistics such as query queue time, planning time, execution time, service processing time, and total execution time.

type nonrec query_runtime_statistics_rows = {
  1. output_rows : long option;
    (*

    The number of rows returned by the query.

    *)
  2. output_bytes : long option;
    (*

    The number of bytes returned by the query.

    *)
  3. input_bytes : long option;
    (*

    The number of bytes read to execute the query.

    *)
  4. input_rows : long option;
    (*

    The number of rows read to execute the query.

    *)
}

Statistics such as input rows and bytes read by the query, rows and bytes output by the query, and the number of rows written by the query.

type nonrec query_runtime_statistics = {
  1. output_stage : query_stage option;
    (*

    Stage statistics such as input and output rows and bytes, execution time, and stage state. This information also includes substages and the query stage plan.

    *)
  2. rows : query_runtime_statistics_rows option;
  3. timeline : query_runtime_statistics_timeline option;
}

The query execution timeline, statistics on input and output rows and bytes, and the different query stages that form the query execution plan.

type nonrec query_result_type =
  1. | DATA_ROWS
  2. | DATA_MANIFEST
type nonrec query_execution_state =
  1. | CANCELLED
  2. | FAILED
  3. | SUCCEEDED
  4. | RUNNING
  5. | QUEUED
type nonrec error_category = int
type nonrec error_type = int
type nonrec athena_error = {
  1. error_message : string_ option;
    (*

    Contains a short description of the error that occurred.

    *)
  2. retryable : boolean_ option;
    (*

    True if the query might succeed if resubmitted.

    *)
  3. error_type : error_type option;
    (*

    An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

    *)
  4. error_category : error_category option;
    (*

    An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

    1 - System

    2 - User

    3 - Other

    *)
}

Provides information about an Athena query error. The AthenaError feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. AthenaError includes an ErrorCategory field that specifies whether the cause of the failed query is due to system error, user error, or other error.

type nonrec query_execution_status = {
  1. athena_error : athena_error option;
    (*

    Provides information about an Athena query error.

    *)
  2. completion_date_time : date option;
    (*

    The date and time that the query completed.

    *)
  3. submission_date_time : date option;
    (*

    The date and time that the query was submitted.

    *)
  4. state_change_reason : string_ option;
    (*

    Further detail about the status of the query.

    *)
  5. state : query_execution_state option;
    (*

    The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

    For queries that experience certain transient errors, the state transitions from RUNNING back to QUEUED. The FAILED state is always terminal with no automatic retry.

    *)
}

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

type nonrec dpu_count = float
type nonrec query_execution_statistics = {
  1. dpu_count : dpu_count option;
    (*

    The number of Data Processing Units (DPUs) that Athena used to run the query.

    *)
  2. result_reuse_information : result_reuse_information option;
    (*

    Contains information about whether previous query results were reused for the query.

    *)
  3. service_processing_time_in_millis : long option;
    (*

    The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

    *)
  4. query_planning_time_in_millis : long option;
    (*

    The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.

    *)
  5. service_pre_processing_time_in_millis : long option;
    (*

    The number of milliseconds that Athena took to preprocess the query before submitting the query to the query engine.

    *)
  6. query_queue_time_in_millis : long option;
    (*

    The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.

    *)
  7. total_execution_time_in_millis : long option;
    (*

    The number of milliseconds that Athena took to run the query.

    *)
  8. data_manifest_location : string_ option;
    (*

    The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.

    *)
  9. data_scanned_in_bytes : long option;
    (*

    The number of bytes in the data that was queried.

    *)
  10. engine_execution_time_in_millis : long option;
    (*

    The number of milliseconds that the query took to execute.

    *)
}

The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.

type nonrec query_execution = {
  1. query_results_s3_access_grants_configuration : query_results_s3_access_grants_configuration option;
    (*

    Specifies whether Amazon S3 access grants are enabled for query results.

    *)
  2. substatement_type : string_ option;
    (*

    The kind of query statement that was run.

    *)
  3. execution_parameters : execution_parameters option;
    (*

    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. The list of parameters is not returned in the response.

    *)
  4. engine_version : engine_version option;
    (*

    The engine version that executed the query.

    *)
  5. work_group : work_group_name option;
    (*

    The name of the workgroup in which the query ran.

    *)
  6. statistics : query_execution_statistics option;
    (*

    Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.

    *)
  7. status : query_execution_status option;
    (*

    The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

    *)
  8. query_execution_context : query_execution_context option;
    (*

    The database in which the query execution occurred.

    *)
  9. result_reuse_configuration : result_reuse_configuration option;
    (*

    Specifies the query result reuse behavior that was used for the query.

    *)
  10. result_configuration : result_configuration option;
    (*

    The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

    *)
  11. managed_query_results_configuration : managed_query_results_configuration option;
    (*

    The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

    *)
  12. statement_type : statement_type option;
    (*

    The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, EXPLAIN, DESCRIBE, or SHOW TABLES.

    *)
  13. query : query_string option;
    (*

    The SQL query statements which the query execution ran.

    *)
  14. query_execution_id : query_execution_id option;
    (*

    The unique identifier for each query execution.

    *)
}

Information about a single instance of a query execution.

type nonrec query_execution_list = query_execution list
type nonrec query_execution_id_list = query_execution_id list
type nonrec put_capacity_assignment_configuration_output = unit
type nonrec capacity_assignment = {
  1. work_group_names : work_group_names_list option;
    (*

    The list of workgroup names for the capacity assignment.

    *)
}

A mapping between one or more workgroups and a capacity reservation.

type nonrec capacity_assignments_list = capacity_assignment list
type nonrec put_capacity_assignment_configuration_input = {
  1. capacity_assignments : capacity_assignments_list;
    (*

    The list of assignments for the capacity assignment configuration.

    *)
  2. capacity_reservation_name : capacity_reservation_name;
    (*

    The name of the capacity reservation to put a capacity assignment configuration for.

    *)
}
type nonrec prepared_statement_summary = {
  1. last_modified_time : date option;
    (*

    The last modified time of the prepared statement.

    *)
  2. statement_name : statement_name option;
    (*

    The name of the prepared statement.

    *)
}

The name and last modified time of the prepared statement.

type nonrec prepared_statements_list = prepared_statement_summary list
type nonrec prepared_statement_name_list = statement_name list
type nonrec prepared_statement = {
  1. last_modified_time : date option;
    (*

    The last modified time of the prepared statement.

    *)
  2. description : description_string option;
    (*

    The description of the prepared statement.

    *)
  3. work_group_name : work_group_name option;
    (*

    The name of the workgroup to which the prepared statement belongs.

    *)
  4. query_statement : query_string option;
    (*

    The query string for the prepared statement.

    *)
  5. statement_name : statement_name option;
    (*

    The name of the prepared statement.

    *)
}

A prepared SQL statement for use with Athena.

type nonrec prepared_statement_details_list = prepared_statement list
type nonrec notebook_session_summary = {
  1. creation_time : date option;
    (*

    The time when the notebook session was created.

    *)
  2. session_id : session_id option;
    (*

    The notebook session ID.

    *)
}

Contains the notebook session ID and notebook session creation time.

type nonrec notebook_sessions_list = notebook_session_summary list
type nonrec notebook_metadata = {
  1. last_modified_time : date option;
    (*

    The time when the notebook was last modified.

    *)
  2. type_ : notebook_type option;
    (*

    The type of notebook. Currently, the only valid type is IPYNB.

    *)
  3. creation_time : date option;
    (*

    The time when the notebook was created.

    *)
  4. work_group : work_group_name option;
    (*

    The name of the Spark enabled workgroup to which the notebook belongs.

    *)
  5. name : notebook_name option;
    (*

    The name of the notebook.

    *)
  6. notebook_id : notebook_id option;
    (*

    The notebook ID.

    *)
}

Contains metadata for notebook, including the notebook name, ID, workgroup, and time created.

type nonrec notebook_metadata_array = notebook_metadata list
type nonrec named_query = {
  1. work_group : work_group_name option;
    (*

    The name of the workgroup that contains the named query.

    *)
  2. named_query_id : named_query_id option;
    (*

    The unique identifier of the query.

    *)
  3. query_string : query_string;
    (*

    The SQL statements that make up the query.

    *)
  4. database : database_string;
    (*

    The database to which the query belongs.

    *)
  5. description : description_string option;
    (*

    The query description.

    *)
  6. name : name_string;
    (*

    The query name.

    *)
}

A query, where QueryString contains the SQL statements that make up the query.

type nonrec named_query_list = named_query list
type nonrec named_query_id_list = named_query_id list
type nonrec metadata_exception = {
  1. message : error_message option;
}

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

type nonrec max_work_groups_count = int
type nonrec max_tags_count = int
type nonrec max_table_metadata_count = int
type nonrec max_sessions_count = int
type nonrec max_query_results = int
type nonrec max_query_executions_count = int
type nonrec max_prepared_statements_count = int
type nonrec max_notebooks_count = int
type nonrec max_named_queries_count = int
type nonrec max_list_executors_count = int
type nonrec max_engine_versions_count = int
type nonrec max_databases_count = int
type nonrec max_data_catalogs_count = int
type nonrec max_capacity_reservations_count = int
type nonrec max_calculations_count = int
type nonrec max_application_dpu_sizes_count = int
type nonrec list_work_groups_output = {
  1. next_token : token option;
    (*

    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.

    *)
  2. work_groups : work_groups_list option;
    (*

    A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.

    *)
}
type nonrec list_work_groups_input = {
  1. max_results : max_work_groups_count option;
    (*

    The maximum number of workgroups to return in this request.

    *)
  2. next_token : token option;
    (*

    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.

    *)
}
type nonrec list_tags_for_resource_output = {
  1. next_token : token option;
    (*

    A token to be used by the next request if this request is truncated.

    *)
  2. tags : tag_list option;
    (*

    The list of tags associated with the specified resource.

    *)
}
type nonrec list_tags_for_resource_input = {
  1. max_results : max_tags_count option;
    (*

    The maximum number of results to be returned per request that lists the tags for the resource.

    *)
  2. next_token : token option;
    (*

    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.

    *)
  3. resource_ar_n : amazon_resource_name;
    (*

    Lists the tags for the resource with the specified ARN.

    *)
}
type nonrec list_table_metadata_output = {
  1. next_token : token option;
    (*

    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.

    *)
  2. table_metadata_list : table_metadata_list option;
    (*

    A list of table metadata.

    *)
}
type nonrec expression_string = string
type nonrec list_table_metadata_input = {
  1. work_group : work_group_name option;
    (*

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

    *)
  2. max_results : max_table_metadata_count option;
    (*

    Specifies the maximum number of results to return.

    *)
  3. next_token : token option;
    (*

    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.

    *)
  4. expression : expression_string option;
    (*

    A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

    *)
  5. database_name : name_string;
    (*

    The name of the database for which table metadata should be returned.

    *)
  6. catalog_name : catalog_name_string;
    (*

    The name of the data catalog for which table metadata should be returned.

    *)
}
type nonrec list_sessions_response = {
  1. sessions : sessions_list option;
    (*

    A list of sessions.

    *)
  2. next_token : session_manager_token option;
    (*

    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.

    *)
}
type nonrec list_sessions_request = {
  1. next_token : session_manager_token option;
    (*

    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.

    *)
  2. max_results : max_sessions_count option;
    (*

    The maximum number of sessions to return.

    *)
  3. state_filter : session_state option;
    (*

    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.

    *)
  4. work_group : work_group_name;
    (*

    The workgroup to which the session belongs.

    *)
}
type nonrec list_query_executions_output = {
  1. next_token : token option;
    (*

    A token to be used by the next request if this request is truncated.

    *)
  2. query_execution_ids : query_execution_id_list option;
    (*

    The unique IDs of each query execution as an array of strings.

    *)
}
type nonrec list_query_executions_input = {
  1. work_group : work_group_name option;
    (*

    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.

    *)
  2. max_results : max_query_executions_count option;
    (*

    The maximum number of query executions to return in this request.

    *)
  3. next_token : token option;
    (*

    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.

    *)
}
type nonrec list_prepared_statements_output = {
  1. next_token : token option;
    (*

    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.

    *)
  2. prepared_statements : prepared_statements_list option;
    (*

    The list of prepared statements for the workgroup.

    *)
}
type nonrec list_prepared_statements_input = {
  1. max_results : max_prepared_statements_count option;
    (*

    The maximum number of results to return in this request.

    *)
  2. next_token : token option;
    (*

    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.

    *)
  3. work_group : work_group_name;
    (*

    The workgroup to list the prepared statements for.

    *)
}
type nonrec list_notebook_sessions_response = {
  1. next_token : token option;
    (*

    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.

    *)
  2. notebook_sessions_list : notebook_sessions_list;
    (*

    A list of the sessions belonging to the notebook.

    *)
}
type nonrec list_notebook_sessions_request = {
  1. next_token : token option;
    (*

    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.

    *)
  2. max_results : max_sessions_count option;
    (*

    The maximum number of notebook sessions to return.

    *)
  3. notebook_id : notebook_id;
    (*

    The ID of the notebook to list sessions for.

    *)
}
type nonrec list_notebook_metadata_output = {
  1. notebook_metadata_list : notebook_metadata_array option;
    (*

    The list of notebook metadata for the specified workgroup.

    *)
  2. next_token : token option;
    (*

    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.

    *)
}
type nonrec filter_definition = {
  1. name : notebook_name option;
    (*

    The name of the notebook to search for.

    *)
}

A string for searching notebook names.

type nonrec list_notebook_metadata_input = {
  1. work_group : work_group_name;
    (*

    The name of the Spark enabled workgroup to retrieve notebook metadata for.

    *)
  2. max_results : max_notebooks_count option;
    (*

    Specifies the maximum number of results to return.

    *)
  3. next_token : token option;
    (*

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

    *)
  4. filters : filter_definition option;
    (*

    Search filter string.

    *)
}
type nonrec list_named_queries_output = {
  1. next_token : token option;
    (*

    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.

    *)
  2. named_query_ids : named_query_id_list option;
    (*

    The list of unique query IDs.

    *)
}
type nonrec list_named_queries_input = {
  1. work_group : work_group_name option;
    (*

    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.

    *)
  2. max_results : max_named_queries_count option;
    (*

    The maximum number of queries to return in this request.

    *)
  3. next_token : token option;
    (*

    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.

    *)
}
type nonrec executor_id = string
type nonrec executor_type =
  1. | WORKER
  2. | GATEWAY
  3. | COORDINATOR
type nonrec executor_state =
  1. | FAILED
  2. | TERMINATED
  3. | TERMINATING
  4. | REGISTERED
  5. | CREATED
  6. | CREATING
type nonrec executors_summary = {
  1. executor_size : long option;
    (*

    The smallest unit of compute that a session can request from Athena. Size is measured in data processing unit (DPU) values, a relative measure of processing power.

    *)
  2. executor_state : executor_state option;
    (*

    The processing state of the executor. 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.

    *)
  3. termination_date_time : long option;
    (*

    The date and time that the executor was terminated.

    *)
  4. start_date_time : long option;
    (*

    The date and time that the executor started.

    *)
  5. executor_type : executor_type option;
    (*

    The type of executor used for the application (COORDINATOR, GATEWAY, or WORKER).

    *)
  6. executor_id : executor_id;
    (*

    The UUID of the executor.

    *)
}

Contains summary information about an executor.

type nonrec executors_summary_list = executors_summary list
type nonrec list_executors_response = {
  1. executors_summary : executors_summary_list option;
    (*

    Contains summary information about the executor.

    *)
  2. next_token : session_manager_token option;
    (*

    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.

    *)
  3. session_id : session_id;
    (*

    The session ID.

    *)
}
type nonrec list_executors_request = {
  1. next_token : session_manager_token option;
    (*

    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.

    *)
  2. max_results : max_list_executors_count option;
    (*

    The maximum number of executors to return.

    *)
  3. executor_state_filter : executor_state option;
    (*

    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.

    *)
  4. session_id : session_id;
    (*

    The session ID.

    *)
}
type nonrec engine_versions_list = engine_version list
type nonrec list_engine_versions_output = {
  1. next_token : token option;
    (*

    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.

    *)
  2. engine_versions : engine_versions_list option;
    (*

    A list of engine versions that are available to choose from.

    *)
}
type nonrec list_engine_versions_input = {
  1. max_results : max_engine_versions_count option;
    (*

    The maximum number of engine versions to return in this request.

    *)
  2. next_token : token option;
    (*

    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.

    *)
}
type nonrec database = {
  1. parameters : parameters_map option;
    (*

    A set of custom key/value pairs.

    *)
  2. description : description_string option;
    (*

    An optional description of the database.

    *)
  3. name : name_string;
    (*

    The name of the database.

    *)
}

Contains metadata information for a database in a data catalog.

type nonrec database_list = database list
type nonrec list_databases_output = {
  1. next_token : token option;
    (*

    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.

    *)
  2. database_list : database_list option;
    (*

    A list of databases from a data catalog.

    *)
}
type nonrec list_databases_input = {
  1. work_group : work_group_name option;
    (*

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

    *)
  2. max_results : max_databases_count option;
    (*

    Specifies the maximum number of results to return.

    *)
  3. next_token : token option;
    (*

    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.

    *)
  4. catalog_name : catalog_name_string;
    (*

    The name of the data catalog that contains the databases to return.

    *)
}
type nonrec data_catalog_status =
  1. | DELETE_FAILED
  2. | DELETE_COMPLETE
  3. | DELETE_IN_PROGRESS
  4. | CREATE_FAILED_CLEANUP_FAILED
  5. | CREATE_FAILED_CLEANUP_COMPLETE
  6. | CREATE_FAILED_CLEANUP_IN_PROGRESS
  7. | CREATE_FAILED
  8. | CREATE_COMPLETE
  9. | CREATE_IN_PROGRESS
type nonrec connection_type =
  1. | DB2AS400
  2. | DATALAKEGEN2
  3. | SNOWFLAKE
  4. | SAPHANA
  5. | TIMESTREAM
  6. | TPCDS
  7. | CMDB
  8. | DOCUMENTDB
  9. | HBASE
  10. | GOOGLECLOUDSTORAGE
  11. | BIGQUERY
  12. | OPENSEARCH
  13. | DB2
  14. | SQLSERVER
  15. | SYNAPSE
  16. | ORACLE
  17. | REDSHIFT
  18. | POSTGRESQL
  19. | MYSQL
  20. | DYNAMODB
type nonrec data_catalog_summary = {
  1. error : error_message option;
    (*

    Text of the error that occurred during data catalog creation or deletion.

    *)
  2. connection_type : connection_type option;
    (*

    The type of connection for a FEDERATED data catalog (for example, REDSHIFT, MYSQL, or SQLSERVER). For information about individual connectors, see Available data source connectors.

    *)
  3. status : data_catalog_status option;
    (*

    The status of the creation or deletion of the data catalog.

    • The LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED.
    • The FEDERATED data catalog type is created asynchronously.

    Data catalog creation status:

    • CREATE_IN_PROGRESS: Federated data catalog creation in progress.
    • CREATE_COMPLETE: Data catalog creation complete.
    • CREATE_FAILED: Data catalog could not be created.
    • CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed.
    • CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed.
    • CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.

    Data catalog deletion status:

    • DELETE_IN_PROGRESS: Federated data catalog deletion in progress.
    • DELETE_COMPLETE: Federated data catalog deleted.
    • DELETE_FAILED: Federated data catalog could not be deleted.
    *)
  4. type_ : data_catalog_type option;
    (*

    The data catalog type.

    *)
  5. catalog_name : catalog_name_string option;
    (*

    The name of the data catalog. The catalog name is 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.

    *)
}

The summary information for the data catalog, which includes its name and type.

type nonrec data_catalog_summary_list = data_catalog_summary list
type nonrec list_data_catalogs_output = {
  1. next_token : token option;
    (*

    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.

    *)
  2. data_catalogs_summary : data_catalog_summary_list option;
    (*

    A summary list of data catalogs.

    *)
}
type nonrec list_data_catalogs_input = {
  1. work_group : work_group_name option;
    (*

    The name of the workgroup. Required if making an IAM Identity Center request.

    *)
  2. max_results : max_data_catalogs_count option;
    (*

    Specifies the maximum number of data catalogs to return.

    *)
  3. next_token : token option;
    (*

    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.

    *)
}
type nonrec capacity_reservation_status =
  1. | UPDATE_PENDING
  2. | FAILED
  3. | CANCELLED
  4. | CANCELLING
  5. | ACTIVE
  6. | PENDING
type nonrec allocated_dpus_integer = int
type nonrec capacity_allocation_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | PENDING
type nonrec capacity_allocation = {
  1. request_completion_time : timestamp option;
    (*

    The time when the capacity allocation request was completed.

    *)
  2. request_time : timestamp;
    (*

    The time when the capacity allocation was requested.

    *)
  3. status_message : string_ option;
    (*

    The status message of the capacity allocation.

    *)
  4. status : capacity_allocation_status;
    (*

    The status of the capacity allocation.

    *)
}

Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.

type nonrec capacity_reservation = {
  1. creation_time : timestamp;
    (*

    The time in UTC epoch millis when the capacity reservation was created.

    *)
  2. last_successful_allocation_time : timestamp option;
    (*

    The time of the most recent capacity allocation that succeeded.

    *)
  3. last_allocation : capacity_allocation option;
  4. allocated_dpus : allocated_dpus_integer;
    (*

    The number of data processing units currently allocated.

    *)
  5. target_dpus : target_dpus_integer;
    (*

    The number of data processing units requested.

    *)
  6. status : capacity_reservation_status;
    (*

    The status of the capacity reservation.

    *)
  7. name : capacity_reservation_name;
    (*

    The name of the capacity reservation.

    *)
}

A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.

type nonrec capacity_reservations_list = capacity_reservation list
type nonrec list_capacity_reservations_output = {
  1. capacity_reservations : capacity_reservations_list;
    (*

    The capacity reservations for the current account.

    *)
  2. next_token : token option;
    (*

    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.

    *)
}
type nonrec list_capacity_reservations_input = {
  1. max_results : max_capacity_reservations_count option;
    (*

    Specifies the maximum number of results to return.

    *)
  2. next_token : token option;
    (*

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

    *)
}
type nonrec calculation_status = {
  1. state_change_reason : description_string option;
    (*

    The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

    *)
  2. state : calculation_execution_state option;
    (*

    The state of the calculation execution. 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.

    *)
  3. completion_date_time : date option;
    (*

    The date and time the calculation completed processing.

    *)
  4. submission_date_time : date option;
    (*

    The date and time the calculation was submitted for processing.

    *)
}

Contains information about the status of a notebook calculation.

type nonrec calculation_summary = {
  1. status : calculation_status option;
    (*

    Contains information about the status of the calculation.

    *)
  2. description : description_string option;
    (*

    A description of the calculation.

    *)
  3. calculation_execution_id : calculation_execution_id option;
    (*

    The calculation execution UUID.

    *)
}

Summary information for a notebook calculation.

type nonrec calculations_list = calculation_summary list
type nonrec list_calculation_executions_response = {
  1. calculations : calculations_list option;
    (*

    A list of CalculationSummary objects.

    *)
  2. next_token : session_manager_token option;
    (*

    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.

    *)
}
type nonrec list_calculation_executions_request = {
  1. next_token : session_manager_token option;
    (*

    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.

    *)
  2. max_results : max_calculations_count option;
    (*

    The maximum number of calculation executions to return.

    *)
  3. state_filter : calculation_execution_state option;
    (*

    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.

    *)
  4. session_id : session_id;
    (*

    The session ID.

    *)
}
type nonrec application_dpu_sizes = {
  1. supported_dpu_sizes : supported_dpu_size_list option;
    (*

    A list of the supported DPU sizes that the application runtime supports.

    *)
  2. application_runtime_id : name_string option;
    (*

    The name of the supported application runtime (for example, Athena notebook version 1).

    *)
}

Contains the application runtime IDs and their supported DPU sizes.

type nonrec application_dpu_sizes_list = application_dpu_sizes list
type nonrec list_application_dpu_sizes_output = {
  1. next_token : token option;
    (*

    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.

    *)
  2. application_dpu_sizes : application_dpu_sizes_list option;
    (*

    A list of the supported DPU sizes that the application runtime supports.

    *)
}
type nonrec list_application_dpu_sizes_input = {
  1. next_token : token option;
    (*

    A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

    *)
  2. max_results : max_application_dpu_sizes_count option;
    (*

    Specifies the maximum number of results to return.

    *)
}
type nonrec import_notebook_output = {
  1. notebook_id : notebook_id option;
    (*

    The ID assigned to the imported notebook.

    *)
}
type nonrec import_notebook_input = {
  1. client_request_token : client_request_token option;
    (*

    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.

    *)
  2. notebook_s3_location_uri : s3_uri option;
    (*

    A URI that specifies the Amazon S3 location of a notebook file in ipynb format.

    *)
  3. type_ : notebook_type;
    (*

    The notebook content type. Currently, the only valid type is IPYNB.

    *)
  4. payload : payload option;
    (*

    The notebook content to be imported. The payload must be in ipynb format.

    *)
  5. name : notebook_name;
    (*

    The name of the notebook to import.

    *)
  6. work_group : work_group_name;
    (*

    The name of the Spark enabled workgroup to import the notebook to.

    *)
}
type nonrec get_work_group_output = {
  1. work_group : work_group option;
    (*

    Information about the workgroup.

    *)
}
type nonrec get_work_group_input = {
  1. work_group : work_group_name;
    (*

    The name of the workgroup.

    *)
}
type nonrec get_table_metadata_output = {
  1. table_metadata : table_metadata option;
    (*

    An object that contains table metadata.

    *)
}
type nonrec get_table_metadata_input = {
  1. work_group : work_group_name option;
    (*

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

    *)
  2. table_name : name_string;
    (*

    The name of the table for which metadata is returned.

    *)
  3. database_name : name_string;
    (*

    The name of the database that contains the table metadata to return.

    *)
  4. catalog_name : catalog_name_string;
    (*

    The name of the data catalog that contains the database and table metadata to return.

    *)
}
type nonrec get_session_status_response = {
  1. status : session_status option;
    (*

    Contains information about the status of the session.

    *)
  2. session_id : session_id option;
    (*

    The session ID.

    *)
}
type nonrec get_session_status_request = {
  1. session_id : session_id;
    (*

    The session ID.

    *)
}
type nonrec get_session_response = {
  1. statistics : session_statistics option;
    (*

    Contains the DPU execution time.

    *)
  2. status : session_status option;
    (*

    Contains information about the status of the session.

    *)
  3. session_configuration : session_configuration option;
    (*

    Contains the workgroup configuration information used by the session.

    *)
  4. monitoring_configuration : monitoring_configuration option;
  5. notebook_version : name_string option;
    (*

    The notebook version.

    *)
  6. engine_configuration : engine_configuration option;
    (*

    Contains engine configuration information like DPU usage.

    *)
  7. engine_version : name_string option;
    (*

    The engine version used by the session (for example, PySpark engine version 3). You can get a list of engine versions by calling ListEngineVersions.

    *)
  8. work_group : work_group_name option;
    (*

    The workgroup to which the session belongs.

    *)
  9. description : description_string option;
    (*

    The session description.

    *)
  10. session_id : session_id option;
    (*

    The session ID.

    *)
}
type nonrec get_session_request = {
  1. session_id : session_id;
    (*

    The session ID.

    *)
}
type nonrec get_session_endpoint_response = {
  1. auth_token_expiration_time : timestamp;
    (*

    Expiration time of the auth token.

    *)
  2. auth_token : string_;
    (*

    Authentication token for the connection

    *)
  3. endpoint_url : string_;
    (*

    The endpoint for connecting to the session.

    *)
}
type nonrec get_session_endpoint_request = {
  1. session_id : session_id;
    (*

    The session ID.

    *)
}
type nonrec get_resource_dashboard_response = {
  1. url : string_;
    (*

    The Live UI/Persistence UI url for a session.

    *)
}
type nonrec get_resource_dashboard_request = {
  1. resource_ar_n : amazon_resource_name;
    (*

    The The Amazon Resource Name (ARN) for a session.

    *)
}
type nonrec get_query_runtime_statistics_output = {
  1. query_runtime_statistics : query_runtime_statistics option;
    (*

    Runtime statistics about the query execution.

    *)
}
type nonrec get_query_runtime_statistics_input = {
  1. query_execution_id : query_execution_id;
    (*

    The unique ID of the query execution.

    *)
}
type nonrec get_query_results_output = {
  1. next_token : token option;
    (*

    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.

    *)
  2. result_set : result_set option;
    (*

    The results of the query execution.

    *)
  3. update_count : long option;
    (*

    The number of rows inserted with a CREATE TABLE AS SELECT, INSERT INTO, or UPDATE statement.

    *)
}
type nonrec get_query_results_input = {
  1. query_result_type : query_result_type option;
    (*

    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.

    *)
  2. max_results : max_query_results option;
    (*

    The maximum number of results (rows) to return in this request.

    *)
  3. next_token : token option;
    (*

    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.

    *)
  4. query_execution_id : query_execution_id;
    (*

    The unique ID of the query execution.

    *)
}
type nonrec get_query_execution_output = {
  1. query_execution : query_execution option;
    (*

    Information about the query execution.

    *)
}
type nonrec get_query_execution_input = {
  1. query_execution_id : query_execution_id;
    (*

    The unique ID of the query execution.

    *)
}
type nonrec get_prepared_statement_output = {
  1. prepared_statement : prepared_statement option;
    (*

    The name of the prepared statement that was retrieved.

    *)
}
type nonrec get_prepared_statement_input = {
  1. work_group : work_group_name;
    (*

    The workgroup to which the statement to be retrieved belongs.

    *)
  2. statement_name : statement_name;
    (*

    The name of the prepared statement to retrieve.

    *)
}
type nonrec get_notebook_metadata_output = {
  1. notebook_metadata : notebook_metadata option;
    (*

    The metadata that is returned for the specified notebook ID.

    *)
}
type nonrec get_notebook_metadata_input = {
  1. notebook_id : notebook_id;
    (*

    The ID of the notebook whose metadata is to be retrieved.

    *)
}
type nonrec get_named_query_output = {
  1. named_query : named_query option;
    (*

    Information about the query.

    *)
}
type nonrec get_named_query_input = {
  1. named_query_id : named_query_id;
    (*

    The unique ID of the query. Use ListNamedQueries to get query IDs.

    *)
}
type nonrec get_database_output = {
  1. database : database option;
    (*

    The database returned.

    *)
}
type nonrec get_database_input = {
  1. work_group : work_group_name option;
    (*

    The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

    *)
  2. database_name : name_string;
    (*

    The name of the database to return.

    *)
  3. catalog_name : catalog_name_string;
    (*

    The name of the data catalog that contains the database to return.

    *)
}
type nonrec data_catalog = {
  1. error : error_message option;
    (*

    Text of the error that occurred during data catalog creation or deletion.

    *)
  2. connection_type : connection_type option;
    (*

    The type of connection for a FEDERATED data catalog (for example, REDSHIFT, MYSQL, or SQLSERVER). For information about individual connectors, see Available data source connectors.

    *)
  3. status : data_catalog_status option;
    (*

    The status of the creation or deletion of the data catalog.

    • The LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED.
    • The FEDERATED data catalog type is created asynchronously.

    Data catalog creation status:

    • CREATE_IN_PROGRESS: Federated data catalog creation in progress.
    • CREATE_COMPLETE: Data catalog creation complete.
    • CREATE_FAILED: Data catalog could not be created.
    • CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed.
    • CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed.
    • CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.

    Data catalog deletion status:

    • DELETE_IN_PROGRESS: Federated data catalog deletion in progress.
    • DELETE_COMPLETE: Federated data catalog deleted.
    • DELETE_FAILED: Federated data catalog could not be deleted.
    *)
  4. parameters : parameters_map option;
    (*

    Specifies the Lambda function or functions to use for 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={i lambda_arn}, sdk-version={i 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={i lambda_arn}, record-function={i 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={i lambda_arn}

    • The GLUE type takes a catalog ID parameter and is required. The

       {i catalog_id}

      is the account ID of the Amazon Web Services account to which the Glue catalog belongs.

      catalog-id={i 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:{i } 
      • connection-type:MYSQL|REDSHIFT|...., connection-properties:"{i }"

        For 

    }
    *)
  5. type_ : data_catalog_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.
    *)
  6. description : description_string option;
    (*
    An optional description of the data catalog.
    *)
  7. name : catalog_name_string;
    (*
    The name of the data catalog. 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.
    *)
}
Contains information about a data catalog in an Amazon Web Services account.
In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.
type nonrec get_data_catalog_output = {
  1. data_catalog : data_catalog option;
    (*
    The data catalog returned.
    *)
}
type nonrec get_data_catalog_input = {
  1. work_group : work_group_name option;
    (*
    The name of the workgroup. Required if making an IAM Identity Center request.
    *)
  2. name : catalog_name_string;
    (*
    The name of the data catalog to return.
    *)
}
type nonrec get_capacity_reservation_output = {
  1. capacity_reservation : capacity_reservation;
    (*
    The requested capacity reservation structure.
    *)
}
type nonrec get_capacity_reservation_input = {
  1. name : capacity_reservation_name;
    (*
    The name of the capacity reservation.
    *)
}
type nonrec capacity_assignment_configuration = {
  1. capacity_assignments : capacity_assignments_list option;
    (*
    The list of assignments that make up the capacity assignment configuration.
    *)
  2. capacity_reservation_name : capacity_reservation_name option;
    (*
    The name of the reservation that the capacity assignment configuration is for.
    *)
}
Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.
type nonrec get_capacity_assignment_configuration_output = {
  1. capacity_assignment_configuration : capacity_assignment_configuration;
    (*
    The requested capacity assignment configuration for the specified capacity reservation.
    *)
}
type nonrec get_capacity_assignment_configuration_input = {
  1. capacity_reservation_name : capacity_reservation_name;
    (*
    The name of the capacity reservation to retrieve the capacity assignment configuration for.
    *)
}
type nonrec calculation_statistics = {
  1. progress : description_string option;
    (*
    The progress of the calculation.
    *)
  2. dpu_execution_in_millis : long option;
    (*
    The data processing unit execution time in milliseconds for the calculation.
    *)
}
Contains statistics for a notebook calculation.
type nonrec get_calculation_execution_status_response = {
  1. statistics : calculation_statistics option;
    (*
    Contains information about the DPU execution time and progress.
    *)
  2. status : calculation_status option;
    (*
    Contains information about the calculation execution status.
    *)
}
type nonrec get_calculation_execution_status_request = {
  1. calculation_execution_id : calculation_execution_id;
    (*
    The calculation execution UUID.
    *)
}
type nonrec calculation_result_type = string
type nonrec calculation_result = {
  1. result_type : calculation_result_type option;
    (*
    The data format of the calculation result.
    *)
  2. result_s3_uri : s3_uri option;
    (*
    The Amazon S3 location of the folder for the calculation results.
    *)
  3. std_error_s3_uri : s3_uri option;
    (*
    The Amazon S3 location of the stderr error messages file for the calculation.
    *)
  4. std_out_s3_uri : s3_uri option;
    (*
    The Amazon S3 location of the stdout file for the calculation.
    *)
}
Contains information about an application-specific calculation result.
type nonrec get_calculation_execution_response = {
  1. result_ : calculation_result option;
    (*
    Contains result information. This field is populated only if the calculation is completed.
    *)
  2. statistics : calculation_statistics option;
    (*
    Contains information about the data processing unit (DPU) execution time and progress. This field is populated only when statistics are available.
    *)
  3. status : calculation_status option;
    (*
    Contains information about the status of the calculation.
    *)
  4. working_directory : s3_uri option;
    (*
    The Amazon S3 location in which calculation results are stored.
    *)
  5. description : description_string option;
    (*
    The description of the calculation execution.
    *)
  6. session_id : session_id option;
    (*
    The session ID that the calculation ran in.
    *)
  7. calculation_execution_id : calculation_execution_id option;
    (*
    The calculation execution UUID.
    *)
}
type nonrec get_calculation_execution_request = {
  1. calculation_execution_id : calculation_execution_id;
    (*
    The calculation execution UUID.
    *)
}
type nonrec get_calculation_execution_code_response = {
  1. code_block : code_block option;
    (*
    The unencrypted code that was executed for the calculation.
    *)
}
type nonrec get_calculation_execution_code_request = {
  1. calculation_execution_id : calculation_execution_id;
    (*
    The calculation execution UUID.
    *)
}
type nonrec export_notebook_output = {
  1. payload : payload option;
    (*
    The content of the exported notebook.
    *)
  2. notebook_metadata : notebook_metadata option;
    (*
    The notebook metadata, including notebook ID, notebook name, and workgroup name.
    *)
}
type nonrec export_notebook_input = {
  1. notebook_id : notebook_id;
    (*
    The ID of the notebook to export.
    *)
}
type nonrec delete_work_group_output = unit
type nonrec delete_work_group_input = {
  1. recursive_delete_option : boxed_boolean option;
    (*
    The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks.
    *)
  2. work_group : work_group_name;
    (*
    The unique name of the workgroup to delete.
    *)
}
type nonrec delete_prepared_statement_output = unit
type nonrec delete_prepared_statement_input = {
  1. work_group : work_group_name;
    (*
    The workgroup to which the statement to be deleted belongs.
    *)
  2. statement_name : statement_name;
    (*
    The name of the prepared statement to delete.
    *)
}
type nonrec delete_notebook_output = unit
type nonrec delete_notebook_input = {
  1. notebook_id : notebook_id;
    (*
    The ID of the notebook to delete.
    *)
}
type nonrec delete_named_query_output = unit
type nonrec delete_named_query_input = {
  1. named_query_id : named_query_id;
    (*
    The unique ID of the query to delete.
    *)
}
type nonrec delete_data_catalog_output = {
  1. data_catalog : data_catalog option;
}
type nonrec delete_data_catalog_input = {
  1. delete_catalog_only : boolean_ option;
    (*
    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.
    *)
  2. name : catalog_name_string;
    (*
    The name of the data catalog to delete.
    *)
}
type nonrec delete_capacity_reservation_output = unit
type nonrec delete_capacity_reservation_input = {
  1. name : capacity_reservation_name;
    (*
    The name of the capacity reservation to delete.
    *)
}
type nonrec create_work_group_output = unit
type nonrec create_work_group_input = {
  1. tags : tag_list option;
    (*
    A list of comma separated tags to add to the workgroup that is created.
    *)
  2. description : work_group_description_string option;
    (*
    The workgroup description.
    *)
  3. configuration : work_group_configuration option;
    (*
    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.
    *)
  4. name : work_group_name;
    (*
    The workgroup name.
    *)
}
type nonrec auth_token = string
type nonrec create_presigned_notebook_url_response = {
  1. auth_token_expiration_time : long;
    (*
    The UTC epoch time when the authentication token expires.
    *)
  2. auth_token : auth_token;
    (*
    The authentication token for the notebook.
    *)
  3. notebook_url : string_;
    (*
    The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook.
    *)
}
type nonrec create_presigned_notebook_url_request = {
  1. session_id : session_id;
    (*
    The session ID.
    *)
}
type nonrec create_prepared_statement_output = unit
type nonrec create_prepared_statement_input = {
  1. description : description_string option;
    (*
    The description of the prepared statement.
    *)
  2. query_statement : query_string;
    (*
    The query string for the prepared statement.
    *)
  3. work_group : work_group_name;
    (*
    The name of the workgroup to which the prepared statement belongs.
    *)
  4. statement_name : statement_name;
    (*
    The name of the prepared statement.
    *)
}
type nonrec create_notebook_output = {
  1. notebook_id : notebook_id option;
    (*
    A unique identifier for the notebook.
    *)
}
type nonrec create_notebook_input = {
  1. client_request_token : client_request_token option;
    (*
    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.
    *)
  2. name : notebook_name;
    (*
    The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.
    *)
  3. work_group : work_group_name;
    (*
    The name of the Spark enabled workgroup in which the notebook will be created.
    *)
}
type nonrec create_named_query_output = {
  1. named_query_id : named_query_id option;
    (*
    The unique ID of the query.
    *)
}
type nonrec create_named_query_input = {
  1. work_group : work_group_name option;
    (*
    The name of the workgroup in which the named query is being created.
    *)
  2. client_request_token : idempotency_token option;
    (*
    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.
    *)
  3. query_string : query_string;
    (*
    The contents of the query with all query statements.
    *)
  4. database : database_string;
    (*
    The database to which the query belongs.
    *)
  5. description : description_string option;
    (*
    The query description.
    *)
  6. name : name_string;
    (*
    The query name.
    *)
}
type nonrec create_data_catalog_output = {
  1. data_catalog : data_catalog option;
}
type nonrec create_data_catalog_input = {
  1. tags : tag_list option;
    (*
    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).
    *)
  2. parameters : parameters_map option;
    (*
    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={i lambda_arn}, sdk-version={i 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={i lambda_arn}, record-function={i 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={i lambda_arn} 
    • The GLUE type takes a catalog ID parameter and is required. The
       {i catalog_id} 
      is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.
      catalog-id={i 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:{i } 
      • 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:"{i }"
        For 
    }
    *)
  3. description : description_string option;
    (*
    A description of the data catalog to be created.
    *)
  4. type_ : data_catalog_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.
    *)
  5. name : catalog_name_string;
    (*
    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.
    *)
}
type nonrec create_capacity_reservation_output = unit
type nonrec create_capacity_reservation_input = {
  1. tags : tag_list option;
    (*
    The tags for the capacity reservation.
    *)
  2. name : capacity_reservation_name;
    (*
    The name of the capacity reservation to create.
    *)
  3. target_dpus : target_dpus_integer;
    (*
    The number of requested data processing units.
    *)
}
type nonrec cancel_capacity_reservation_output = unit
type nonrec cancel_capacity_reservation_input = {
  1. name : capacity_reservation_name;
    (*
    The name of the capacity reservation to cancel.
    *)
}
type nonrec batch_get_query_execution_output = {
  1. unprocessed_query_execution_ids : unprocessed_query_execution_id_list option;
    (*
    Information about the query executions that failed to run.
    *)
  2. query_executions : query_execution_list option;
    (*
    Information about a query execution.
    *)
}
type nonrec batch_get_query_execution_input = {
  1. query_execution_ids : query_execution_id_list;
    (*
    An array of query execution IDs.
    *)
}
Contains an array of query execution IDs.
type nonrec batch_get_prepared_statement_output = {
  1. unprocessed_prepared_statement_names : unprocessed_prepared_statement_name_list
                                         option;
    (*
    A list of one or more prepared statements that were requested but could not be returned.
    *)
  2. prepared_statements : prepared_statement_details_list option;
    (*
    The list of prepared statements returned.
    *)
}
type nonrec batch_get_prepared_statement_input = {
  1. work_group : work_group_name;
    (*
    The name of the workgroup to which the prepared statements belong.
    *)
  2. prepared_statement_names : prepared_statement_name_list;
    (*
    A list of prepared statement names to return.
    *)
}
type nonrec batch_get_named_query_output = {
  1. unprocessed_named_query_ids : unprocessed_named_query_id_list option;
    (*
    Information about provided query IDs.
    *)
  2. named_queries : named_query_list option;
    (*
    Information about the named query IDs submitted.
    *)
}
type nonrec batch_get_named_query_input = {
  1. named_query_ids : named_query_id_list;
    (*
    An array of query IDs.
    *)
}
Contains an array of named query IDs.