Module Awso_athena_lwtSource

include module type of struct include Awso_athena.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval targetPrefix : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

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.

Sourcemodule AllocatedDpusInteger = Awso_athena.Values.AllocatedDpusInteger
Sourcemodule SupportedDPUSizeList = Awso_athena.Values.SupportedDPUSizeList

Contains the application runtime IDs and their supported DPU sizes.

Sourcemodule ApplicationDPUSizesList = Awso_athena.Values.ApplicationDPUSizesList

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.

Sourcemodule BatchGetNamedQueryInput = Awso_athena.Values.BatchGetNamedQueryInput

Contains an array of named query IDs.

The error code returned when the query execution failed to process, or when the processing request for the named query failed.

Sourcemodule UnprocessedNamedQueryId = Awso_athena.Values.UnprocessedNamedQueryId

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

Sourcemodule UnprocessedNamedQueryIdList = Awso_athena.Values.UnprocessedNamedQueryIdList

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

Sourcemodule InvalidRequestException = Awso_athena.Values.InvalidRequestException

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

Sourcemodule InternalServerException = Awso_athena.Values.InternalServerException

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

Sourcemodule BatchGetNamedQueryOutput = Awso_athena.Values.BatchGetNamedQueryOutput

Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.

Sourcemodule PreparedStatementNameList = Awso_athena.Values.PreparedStatementNameList
Sourcemodule BatchGetPreparedStatementInput = Awso_athena.Values.BatchGetPreparedStatementInput

Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames.

Sourcemodule UnprocessedPreparedStatementName = Awso_athena.Values.UnprocessedPreparedStatementName

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

Sourcemodule UnprocessedPreparedStatementNameList = Awso_athena.Values.UnprocessedPreparedStatementNameList

A prepared SQL statement for use with Athena.

Sourcemodule PreparedStatementDetailsList = Awso_athena.Values.PreparedStatementDetailsList
Sourcemodule BatchGetPreparedStatementOutput = Awso_athena.Values.BatchGetPreparedStatementOutput

Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames.

Sourcemodule QueryExecutionIdList = Awso_athena.Values.QueryExecutionIdList
Sourcemodule BatchGetQueryExecutionInput = Awso_athena.Values.BatchGetQueryExecutionInput

Contains an array of query execution IDs.

Sourcemodule UnprocessedQueryExecutionId = Awso_athena.Values.UnprocessedQueryExecutionId

Describes a query execution that failed to process.

Sourcemodule UnprocessedQueryExecutionIdList = Awso_athena.Values.UnprocessedQueryExecutionIdList
Sourcemodule ResultReuseByAgeConfiguration = Awso_athena.Values.ResultReuseByAgeConfiguration

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

Sourcemodule ResultReuseConfiguration = Awso_athena.Values.ResultReuseConfiguration

Specifies the query result reuse behavior for the query.

Sourcemodule ResultOutputLocation = Awso_athena.Values.ResultOutputLocation
Sourcemodule EncryptionConfiguration = Awso_athena.Values.EncryptionConfiguration

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.

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.

Sourcemodule QueryResultsS3AccessGrantsConfiguration = Awso_athena.Values.QueryResultsS3AccessGrantsConfiguration

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

Sourcemodule QueryExecutionStatus = Awso_athena.Values.QueryExecutionStatus

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

Sourcemodule ResultReuseInformation = Awso_athena.Values.ResultReuseInformation

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

Sourcemodule QueryExecutionStatistics = Awso_athena.Values.QueryExecutionStatistics

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.

Sourcemodule QueryExecutionContext = Awso_athena.Values.QueryExecutionContext

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

Sourcemodule ManagedQueryResultsEncryptionConfiguration = Awso_athena.Values.ManagedQueryResultsEncryptionConfiguration

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.

Sourcemodule ManagedQueryResultsConfiguration = Awso_athena.Values.ManagedQueryResultsConfiguration

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.

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

Information about a single instance of a query execution.

Sourcemodule BatchGetQueryExecutionOutput = Awso_athena.Values.BatchGetQueryExecutionOutput

Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.

Sourcemodule BytesScannedCutoffValue = Awso_athena.Values.BytesScannedCutoffValue
Sourcemodule CalculationConfiguration = Awso_athena.Values.CalculationConfiguration

Contains configuration information for the calculation.

Sourcemodule CalculationExecutionId = Awso_athena.Values.CalculationExecutionId
Sourcemodule CalculationExecutionState = Awso_athena.Values.CalculationExecutionState
Sourcemodule CalculationResultType = Awso_athena.Values.CalculationResultType

Contains information about an application-specific calculation result.

Sourcemodule CalculationStatistics = Awso_athena.Values.CalculationStatistics

Contains statistics for a notebook calculation.

Contains information about the status of a notebook calculation.

Summary information for a notebook calculation.

Sourcemodule CapacityReservationName = Awso_athena.Values.CapacityReservationName
Sourcemodule CancelCapacityReservationInput = Awso_athena.Values.CancelCapacityReservationInput

Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

Sourcemodule CancelCapacityReservationOutput = Awso_athena.Values.CancelCapacityReservationOutput

Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

Sourcemodule CapacityAllocationStatus = Awso_athena.Values.CapacityAllocationStatus

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

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

Sourcemodule CapacityAssignmentsList = Awso_athena.Values.CapacityAssignmentsList
Sourcemodule CapacityAssignmentConfiguration = Awso_athena.Values.CapacityAssignmentConfiguration

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.

Sourcemodule CapacityReservationStatus = Awso_athena.Values.CapacityReservationStatus

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.

Sourcemodule CapacityReservationsList = Awso_athena.Values.CapacityReservationsList

A classification refers to a set of specific configurations.

Sourcemodule CloudWatchLoggingConfiguration = Awso_athena.Values.CloudWatchLoggingConfiguration

Configuration settings for delivering logs to Amazon CloudWatch log groups.

Contains metadata for a column in a table.

Information about the columns in a query execution result.

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.

Sourcemodule CreateCapacityReservationInput = Awso_athena.Values.CreateCapacityReservationInput

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

Sourcemodule CreateCapacityReservationOutput = Awso_athena.Values.CreateCapacityReservationOutput

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

Sourcemodule CreateDataCatalogInput = Awso_athena.Values.CreateDataCatalogInput

Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account. For a FEDERATED catalog, this API operation creates the following resources. CFN Stack Name with a maximum length of 128 characters and prefix athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23 characters. Lambda Function Name with a maximum length of 64 characters and prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters. Glue Connection Name with a maximum length of 255 characters and a prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.

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.

Sourcemodule CreateDataCatalogOutput = Awso_athena.Values.CreateDataCatalogOutput

Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account. For a FEDERATED catalog, this API operation creates the following resources. CFN Stack Name with a maximum length of 128 characters and prefix athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23 characters. Lambda Function Name with a maximum length of 64 characters and prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters. Glue Connection Name with a maximum length of 255 characters and a prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.

Sourcemodule CreateNamedQueryInput = Awso_athena.Values.CreateNamedQueryInput

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

Sourcemodule CreateNamedQueryOutput = Awso_athena.Values.CreateNamedQueryOutput

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

Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

Sourcemodule TooManyRequestsException = Awso_athena.Values.TooManyRequestsException

Indicates that the request was throttled.

Sourcemodule CreateNotebookOutput = Awso_athena.Values.CreateNotebookOutput

Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

Sourcemodule CreatePreparedStatementInput = Awso_athena.Values.CreatePreparedStatementInput

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

Sourcemodule CreatePreparedStatementOutput = Awso_athena.Values.CreatePreparedStatementOutput

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

Sourcemodule CreatePresignedNotebookUrlRequest = Awso_athena.Values.CreatePresignedNotebookUrlRequest

Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.

Sourcemodule ResourceNotFoundException = Awso_athena.Values.ResourceNotFoundException

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

Sourcemodule CreatePresignedNotebookUrlResponse = Awso_athena.Values.CreatePresignedNotebookUrlResponse

Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.

Sourcemodule WorkGroupDescriptionString = Awso_athena.Values.WorkGroupDescriptionString
Sourcemodule S3LoggingConfiguration = Awso_athena.Values.S3LoggingConfiguration

Configuration settings for delivering logs to Amazon S3 buckets.

Sourcemodule ManagedLoggingConfiguration = Awso_athena.Values.ManagedLoggingConfiguration

Configuration settings for delivering logs to Amazon S3 buckets.

Sourcemodule MonitoringConfiguration = Awso_athena.Values.MonitoringConfiguration

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

Sourcemodule IdentityCenterInstanceArn = Awso_athena.Values.IdentityCenterInstanceArn
Sourcemodule IdentityCenterConfiguration = Awso_athena.Values.IdentityCenterConfiguration

Specifies whether the workgroup is IAM Identity Center supported.

Sourcemodule DefaultExecutorDpuSize = Awso_athena.Values.DefaultExecutorDpuSize

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.

Sourcemodule CustomerContentEncryptionConfiguration = Awso_athena.Values.CustomerContentEncryptionConfiguration

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.

Sourcemodule WorkGroupConfiguration = Awso_athena.Values.WorkGroupConfiguration

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.

Sourcemodule CreateWorkGroupInput = Awso_athena.Values.CreateWorkGroupInput

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

Sourcemodule CreateWorkGroupOutput = Awso_athena.Values.CreateWorkGroupOutput

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

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

Sourcemodule DataCatalogSummaryList = Awso_athena.Values.DataCatalogSummaryList

Contains metadata information for a database in a data catalog.

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

Sourcemodule DeleteCapacityReservationInput = Awso_athena.Values.DeleteCapacityReservationInput

Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.

Sourcemodule DeleteCapacityReservationOutput = Awso_athena.Values.DeleteCapacityReservationOutput

Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.

Sourcemodule DeleteDataCatalogInput = Awso_athena.Values.DeleteDataCatalogInput

Deletes a data catalog.

Sourcemodule DeleteDataCatalogOutput = Awso_athena.Values.DeleteDataCatalogOutput

Deletes a data catalog.

Sourcemodule DeleteNamedQueryInput = Awso_athena.Values.DeleteNamedQueryInput

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

Sourcemodule DeleteNamedQueryOutput = Awso_athena.Values.DeleteNamedQueryOutput

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

Deletes the specified notebook.

Sourcemodule DeleteNotebookOutput = Awso_athena.Values.DeleteNotebookOutput

Deletes the specified notebook.

Sourcemodule DeletePreparedStatementInput = Awso_athena.Values.DeletePreparedStatementInput

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

Sourcemodule DeletePreparedStatementOutput = Awso_athena.Values.DeletePreparedStatementOutput

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

Sourcemodule DeleteWorkGroupInput = Awso_athena.Values.DeleteWorkGroupInput

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

Sourcemodule DeleteWorkGroupOutput = Awso_athena.Values.DeleteWorkGroupOutput

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

Contains summary information about an executor.

Sourcemodule ExecutorsSummaryList = Awso_athena.Values.ExecutorsSummaryList

Exports the specified notebook and its metadata.

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

Sourcemodule ExportNotebookOutput = Awso_athena.Values.ExportNotebookOutput

Exports the specified notebook and its metadata.

A string for searching notebook names.

Sourcemodule GetCalculationExecutionCodeRequest = Awso_athena.Values.GetCalculationExecutionCodeRequest

Retrieves the unencrypted code that was executed for the calculation.

Sourcemodule GetCalculationExecutionCodeResponse = Awso_athena.Values.GetCalculationExecutionCodeResponse

Retrieves the unencrypted code that was executed for the calculation.

Sourcemodule GetCalculationExecutionRequest = Awso_athena.Values.GetCalculationExecutionRequest

Describes a previously submitted calculation execution.

Sourcemodule GetCalculationExecutionResponse = Awso_athena.Values.GetCalculationExecutionResponse

Describes a previously submitted calculation execution.

Sourcemodule GetCalculationExecutionStatusRequest = Awso_athena.Values.GetCalculationExecutionStatusRequest

Gets the status of a current calculation.

Sourcemodule GetCalculationExecutionStatusResponse = Awso_athena.Values.GetCalculationExecutionStatusResponse

Gets the status of a current calculation.

Sourcemodule GetCapacityAssignmentConfigurationInput = Awso_athena.Values.GetCapacityAssignmentConfigurationInput

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

Sourcemodule GetCapacityAssignmentConfigurationOutput = Awso_athena.Values.GetCapacityAssignmentConfigurationOutput

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

Sourcemodule GetCapacityReservationInput = Awso_athena.Values.GetCapacityReservationInput

Returns information about the capacity reservation with the specified name.

Sourcemodule GetCapacityReservationOutput = Awso_athena.Values.GetCapacityReservationOutput

Returns information about the capacity reservation with the specified name.

Returns the specified data catalog.

Sourcemodule GetDataCatalogOutput = Awso_athena.Values.GetDataCatalogOutput

Returns the specified data catalog.

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

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.

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

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

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

Sourcemodule GetNotebookMetadataInput = Awso_athena.Values.GetNotebookMetadataInput

Retrieves notebook metadata for the specified notebook ID.

Sourcemodule GetNotebookMetadataOutput = Awso_athena.Values.GetNotebookMetadataOutput

Retrieves notebook metadata for the specified notebook ID.

Sourcemodule GetPreparedStatementInput = Awso_athena.Values.GetPreparedStatementInput

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

Sourcemodule GetPreparedStatementOutput = Awso_athena.Values.GetPreparedStatementOutput

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

Sourcemodule GetQueryExecutionInput = Awso_athena.Values.GetQueryExecutionInput

Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.

Sourcemodule GetQueryExecutionOutput = Awso_athena.Values.GetQueryExecutionOutput

Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.

Sourcemodule GetQueryResultsInput = Awso_athena.Values.GetQueryResultsInput

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query. To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location. IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

The rows that make up a query result table.

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

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.

Sourcemodule GetQueryResultsOutput = Awso_athena.Values.GetQueryResultsOutput

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query. To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location. IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

Sourcemodule GetQueryRuntimeStatisticsInput = Awso_athena.Values.GetQueryRuntimeStatisticsInput

Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the Timeline section of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes or, in some cases, may not be returned. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.

module QueryStagePlanNode = Awso_athena.Values.QueryStagePlanNode

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

module QueryStagePlanNodes = Awso_athena.Values.QueryStagePlanNodes
module QueryStage = Awso_athena.Values.QueryStage

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.

module QueryStages = Awso_athena.Values.QueryStages
Sourcemodule QueryRuntimeStatisticsTimeline = Awso_athena.Values.QueryRuntimeStatisticsTimeline

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

Sourcemodule QueryRuntimeStatisticsRows = Awso_athena.Values.QueryRuntimeStatisticsRows

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.

Sourcemodule QueryRuntimeStatistics = Awso_athena.Values.QueryRuntimeStatistics

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

Sourcemodule GetQueryRuntimeStatisticsOutput = Awso_athena.Values.GetQueryRuntimeStatisticsOutput

Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the Timeline section of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes or, in some cases, may not be returned. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.

Sourcemodule GetResourceDashboardRequest = Awso_athena.Values.GetResourceDashboardRequest

Gets the Live UI/Persistence UI for a session.

Sourcemodule GetResourceDashboardResponse = Awso_athena.Values.GetResourceDashboardResponse

Gets the Live UI/Persistence UI for a session.

Sourcemodule GetSessionEndpointRequest = Awso_athena.Values.GetSessionEndpointRequest

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

Sourcemodule GetSessionEndpointResponse = Awso_athena.Values.GetSessionEndpointResponse

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

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

Contains information about the status of a session.

Contains statistics for a session.

Sourcemodule SessionIdleTimeoutInMinutes = Awso_athena.Values.SessionIdleTimeoutInMinutes
Sourcemodule SessionConfiguration = Awso_athena.Values.SessionConfiguration

Contains session configuration information.

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

Sourcemodule GetSessionStatusRequest = Awso_athena.Values.GetSessionStatusRequest

Gets the current status of a session.

Sourcemodule GetSessionStatusResponse = Awso_athena.Values.GetSessionStatusResponse

Gets the current status of a session.

Sourcemodule GetTableMetadataInput = Awso_athena.Values.GetTableMetadataInput

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

Contains metadata for a table.

Sourcemodule GetTableMetadataOutput = Awso_athena.Values.GetTableMetadataOutput

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

Returns information about the workgroup with the specified name.

Sourcemodule IdentityCenterApplicationArn = Awso_athena.Values.IdentityCenterApplicationArn

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.

Returns information about the workgroup with the specified name.

Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.

Sourcemodule ImportNotebookOutput = Awso_athena.Values.ImportNotebookOutput

Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.

Sourcemodule MaxApplicationDPUSizesCount = Awso_athena.Values.MaxApplicationDPUSizesCount
Sourcemodule ListApplicationDPUSizesInput = Awso_athena.Values.ListApplicationDPUSizesInput

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

Sourcemodule ListApplicationDPUSizesOutput = Awso_athena.Values.ListApplicationDPUSizesOutput

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

Sourcemodule MaxCalculationsCount = Awso_athena.Values.MaxCalculationsCount
Sourcemodule ListCalculationExecutionsRequest = Awso_athena.Values.ListCalculationExecutionsRequest

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

Sourcemodule ListCalculationExecutionsResponse = Awso_athena.Values.ListCalculationExecutionsResponse

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

Sourcemodule MaxCapacityReservationsCount = Awso_athena.Values.MaxCapacityReservationsCount
Sourcemodule ListCapacityReservationsInput = Awso_athena.Values.ListCapacityReservationsInput

Lists the capacity reservations for the current account.

Sourcemodule ListCapacityReservationsOutput = Awso_athena.Values.ListCapacityReservationsOutput

Lists the capacity reservations for the current account.

Sourcemodule MaxDataCatalogsCount = Awso_athena.Values.MaxDataCatalogsCount
Sourcemodule ListDataCatalogsInput = Awso_athena.Values.ListDataCatalogsInput

Lists the data catalogs in the current 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.

Sourcemodule ListDataCatalogsOutput = Awso_athena.Values.ListDataCatalogsOutput

Lists the data catalogs in the current 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.

Lists the databases in the specified data catalog.

Lists the databases in the specified data catalog.

Sourcemodule MaxEngineVersionsCount = Awso_athena.Values.MaxEngineVersionsCount
Sourcemodule ListEngineVersionsInput = Awso_athena.Values.ListEngineVersionsInput

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

Sourcemodule ListEngineVersionsOutput = Awso_athena.Values.ListEngineVersionsOutput

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

Sourcemodule MaxListExecutorsCount = Awso_athena.Values.MaxListExecutorsCount
Sourcemodule ListExecutorsRequest = Awso_athena.Values.ListExecutorsRequest

Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

Sourcemodule ListExecutorsResponse = Awso_athena.Values.ListExecutorsResponse

Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

Sourcemodule MaxNamedQueriesCount = Awso_athena.Values.MaxNamedQueriesCount
Sourcemodule ListNamedQueriesInput = Awso_athena.Values.ListNamedQueriesInput

Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.

Sourcemodule ListNamedQueriesOutput = Awso_athena.Values.ListNamedQueriesOutput

Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.

Sourcemodule ListNotebookMetadataInput = Awso_athena.Values.ListNotebookMetadataInput

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

Sourcemodule NotebookMetadataArray = Awso_athena.Values.NotebookMetadataArray
Sourcemodule ListNotebookMetadataOutput = Awso_athena.Values.ListNotebookMetadataOutput

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

Sourcemodule ListNotebookSessionsRequest = Awso_athena.Values.ListNotebookSessionsRequest

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.

Sourcemodule NotebookSessionSummary = Awso_athena.Values.NotebookSessionSummary

Contains the notebook session ID and notebook session creation time.

Sourcemodule NotebookSessionsList = Awso_athena.Values.NotebookSessionsList
Sourcemodule ListNotebookSessionsResponse = Awso_athena.Values.ListNotebookSessionsResponse

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.

Sourcemodule MaxPreparedStatementsCount = Awso_athena.Values.MaxPreparedStatementsCount
Sourcemodule ListPreparedStatementsInput = Awso_athena.Values.ListPreparedStatementsInput

Lists the prepared statements in the specified workgroup.

Sourcemodule PreparedStatementSummary = Awso_athena.Values.PreparedStatementSummary

The name and last modified time of the prepared statement.

Sourcemodule PreparedStatementsList = Awso_athena.Values.PreparedStatementsList
Sourcemodule ListPreparedStatementsOutput = Awso_athena.Values.ListPreparedStatementsOutput

Lists the prepared statements in the specified workgroup.

Sourcemodule MaxQueryExecutionsCount = Awso_athena.Values.MaxQueryExecutionsCount
Sourcemodule ListQueryExecutionsInput = Awso_athena.Values.ListQueryExecutionsInput

Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.

Sourcemodule ListQueryExecutionsOutput = Awso_athena.Values.ListQueryExecutionsOutput

Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Contains summary information about a session.

Sourcemodule ListSessionsResponse = Awso_athena.Values.ListSessionsResponse

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Sourcemodule MaxTableMetadataCount = Awso_athena.Values.MaxTableMetadataCount
Sourcemodule ListTableMetadataInput = Awso_athena.Values.ListTableMetadataInput

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

Sourcemodule ListTableMetadataOutput = Awso_athena.Values.ListTableMetadataOutput

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

Sourcemodule ListTagsForResourceInput = Awso_athena.Values.ListTagsForResourceInput

Lists the tags associated with an Athena resource.

Sourcemodule ListTagsForResourceOutput = Awso_athena.Values.ListTagsForResourceOutput

Lists the tags associated with an Athena resource.

Lists available workgroups for the account.

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

Sourcemodule ListWorkGroupsOutput = Awso_athena.Values.ListWorkGroupsOutput

Lists available workgroups for the account.

Sourcemodule ManagedQueryResultsConfigurationUpdates = Awso_athena.Values.ManagedQueryResultsConfigurationUpdates

Updates the configuration for managed query results.

Sourcemodule NamedQueryDescriptionString = Awso_athena.Values.NamedQueryDescriptionString
Sourcemodule PutCapacityAssignmentConfigurationInput = Awso_athena.Values.PutCapacityAssignmentConfigurationInput

Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.

Sourcemodule PutCapacityAssignmentConfigurationOutput = Awso_athena.Values.PutCapacityAssignmentConfigurationOutput

Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.

Sourcemodule ResultConfigurationUpdates = Awso_athena.Values.ResultConfigurationUpdates

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

Sourcemodule SessionAlreadyExistsException = Awso_athena.Values.SessionAlreadyExistsException

The specified session already exists.

Sourcemodule StartCalculationExecutionRequest = Awso_athena.Values.StartCalculationExecutionRequest

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request. The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.

Sourcemodule StartCalculationExecutionResponse = Awso_athena.Values.StartCalculationExecutionResponse

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request. The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.

Sourcemodule StartQueryExecutionInput = Awso_athena.Values.StartQueryExecutionInput

Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Sourcemodule StartQueryExecutionOutput = Awso_athena.Values.StartQueryExecutionOutput

Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

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

Sourcemodule StartSessionResponse = Awso_athena.Values.StartSessionResponse

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

Sourcemodule StopCalculationExecutionRequest = Awso_athena.Values.StopCalculationExecutionRequest

Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect. Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.

Sourcemodule StopCalculationExecutionResponse = Awso_athena.Values.StopCalculationExecutionResponse

Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect. Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.

Sourcemodule StopQueryExecutionInput = Awso_athena.Values.StopQueryExecutionInput

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

Sourcemodule StopQueryExecutionOutput = Awso_athena.Values.StopQueryExecutionOutput

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

Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

Sourcemodule TerminateSessionRequest = Awso_athena.Values.TerminateSessionRequest

Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.

Sourcemodule TerminateSessionResponse = Awso_athena.Values.TerminateSessionResponse

Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.

Removes one or more tags from an Athena resource.

Removes one or more tags from an Athena resource.

Sourcemodule UpdateCapacityReservationInput = Awso_athena.Values.UpdateCapacityReservationInput

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

Sourcemodule UpdateCapacityReservationOutput = Awso_athena.Values.UpdateCapacityReservationOutput

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

Sourcemodule UpdateDataCatalogInput = Awso_athena.Values.UpdateDataCatalogInput

Updates the data catalog that has the specified name.

Sourcemodule UpdateDataCatalogOutput = Awso_athena.Values.UpdateDataCatalogOutput

Updates the data catalog that has the specified name.

Sourcemodule UpdateNamedQueryInput = Awso_athena.Values.UpdateNamedQueryInput

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

Sourcemodule UpdateNamedQueryOutput = Awso_athena.Values.UpdateNamedQueryOutput

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

Updates the contents of a Spark notebook.

Sourcemodule UpdateNotebookMetadataInput = Awso_athena.Values.UpdateNotebookMetadataInput

Updates the metadata for a notebook.

Sourcemodule UpdateNotebookMetadataOutput = Awso_athena.Values.UpdateNotebookMetadataOutput

Updates the metadata for a notebook.

Sourcemodule UpdateNotebookOutput = Awso_athena.Values.UpdateNotebookOutput

Updates the contents of a Spark notebook.

Sourcemodule UpdatePreparedStatementInput = Awso_athena.Values.UpdatePreparedStatementInput

Updates a prepared statement.

Sourcemodule UpdatePreparedStatementOutput = Awso_athena.Values.UpdatePreparedStatementOutput

Updates a prepared statement.

Sourcemodule WorkGroupConfigurationUpdates = Awso_athena.Values.WorkGroupConfigurationUpdates

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.

Sourcemodule UpdateWorkGroupInput = Awso_athena.Values.UpdateWorkGroupInput

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

Sourcemodule UpdateWorkGroupOutput = Awso_athena.Values.UpdateWorkGroupOutput

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.