Values (p.awso.0.9.1.doc.awso.athena.Awso

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

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule S3AclOption : sig ... end

Sourcemodule AclConfiguration : sig ... end

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 Age : sig ... end

Sourcemodule AllocatedDpusInteger : sig ... end

Sourcemodule AmazonResourceName : sig ... end

Sourcemodule Integer : sig ... end

Sourcemodule SupportedDPUSizeList : sig ... end

Sourcemodule NameString : sig ... end

Sourcemodule ApplicationDPUSizes : sig ... end

Contains the application runtime IDs and their supported DPU sizes.

Sourcemodule ApplicationDPUSizesList : sig ... end

Sourcemodule String_ : sig ... end

Sourcemodule ErrorType : sig ... end

Sourcemodule ErrorCategory : sig ... end

Sourcemodule Boolean : sig ... end

Sourcemodule AthenaError : sig ... end

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 AuthToken : sig ... end

Sourcemodule AuthenticationType : sig ... end

Sourcemodule AwsAccountId : sig ... end

Sourcemodule NamedQueryId : sig ... end

Sourcemodule NamedQueryIdList : sig ... end

Sourcemodule BatchGetNamedQueryInput : sig ... end

Contains an array of named query IDs.

Sourcemodule ErrorMessage : sig ... end

Sourcemodule ErrorCode : sig ... end

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

Sourcemodule UnprocessedNamedQueryId : sig ... end

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

Sourcemodule UnprocessedNamedQueryIdList : sig ... end

Sourcemodule WorkGroupName : sig ... end

Sourcemodule QueryString : sig ... end

Sourcemodule DescriptionString : sig ... end

Sourcemodule DatabaseString : sig ... end

Sourcemodule NamedQuery : sig ... end

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

Sourcemodule NamedQueryList : sig ... end

Sourcemodule InvalidRequestException : sig ... end

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 : sig ... end

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

Sourcemodule BatchGetNamedQueryOutput : sig ... end

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

Sourcemodule StatementName : sig ... end

Sourcemodule PreparedStatementNameList : sig ... end

Sourcemodule BatchGetPreparedStatementInput : sig ... end

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

Sourcemodule UnprocessedPreparedStatementName : sig ... end

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

Sourcemodule UnprocessedPreparedStatementNameList : sig ... end

Sourcemodule Date : sig ... end

Sourcemodule PreparedStatement : sig ... end

A prepared SQL statement for use with Athena.

Sourcemodule PreparedStatementDetailsList : sig ... end

Sourcemodule BatchGetPreparedStatementOutput : sig ... end

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

Sourcemodule QueryExecutionId : sig ... end

Sourcemodule QueryExecutionIdList : sig ... end

Sourcemodule BatchGetQueryExecutionInput : sig ... end

Contains an array of query execution IDs.

Sourcemodule UnprocessedQueryExecutionId : sig ... end

Describes a query execution that failed to process.

Sourcemodule UnprocessedQueryExecutionIdList : sig ... end

Sourcemodule StatementType : sig ... end

Sourcemodule ResultReuseByAgeConfiguration : sig ... end

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

Sourcemodule ResultReuseConfiguration : sig ... end

Specifies the query result reuse behavior for the query.

Sourcemodule ResultOutputLocation : sig ... end

Sourcemodule EncryptionOption : sig ... end

Sourcemodule EncryptionConfiguration : sig ... end

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.

Sourcemodule ResultConfiguration : sig ... end

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 BoxedBoolean : sig ... end

Sourcemodule QueryResultsS3AccessGrantsConfiguration : sig ... end

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

Sourcemodule QueryExecutionState : sig ... end

Sourcemodule QueryExecutionStatus : sig ... end

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

Sourcemodule ResultReuseInformation : sig ... end

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

Sourcemodule Long : sig ... end

Sourcemodule DpuCount : sig ... end

Sourcemodule QueryExecutionStatistics : sig ... end

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 CatalogNameString : sig ... end

Sourcemodule QueryExecutionContext : sig ... end

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

Sourcemodule KmsKey : sig ... end

Sourcemodule ManagedQueryResultsEncryptionConfiguration : sig ... end

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 : sig ... end

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.

Sourcemodule ExecutionParameter : sig ... end

Sourcemodule ExecutionParameters : sig ... end

Sourcemodule EngineVersion : sig ... end

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

Sourcemodule QueryExecution : sig ... end

Information about a single instance of a query execution.

Sourcemodule QueryExecutionList : sig ... end

Sourcemodule BatchGetQueryExecutionOutput : sig ... end

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

Sourcemodule BytesScannedCutoffValue : sig ... end

Sourcemodule CodeBlock : sig ... end

Sourcemodule CalculationConfiguration : sig ... end

Contains configuration information for the calculation.

Sourcemodule CalculationExecutionId : sig ... end

Sourcemodule CalculationExecutionState : sig ... end

Sourcemodule S3Uri : sig ... end

Sourcemodule CalculationResultType : sig ... end

Sourcemodule CalculationResult : sig ... end

Contains information about an application-specific calculation result.

Sourcemodule CalculationStatistics : sig ... end

Contains statistics for a notebook calculation.

Sourcemodule CalculationStatus : sig ... end

Contains information about the status of a notebook calculation.

Sourcemodule CalculationSummary : sig ... end

Summary information for a notebook calculation.

Sourcemodule CalculationsList : sig ... end

Sourcemodule CapacityReservationName : sig ... end

Sourcemodule CancelCapacityReservationInput : sig ... end

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

Sourcemodule CancelCapacityReservationOutput : sig ... end

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

Sourcemodule Timestamp : sig ... end

Sourcemodule CapacityAllocationStatus : sig ... end

Sourcemodule CapacityAllocation : sig ... end

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

Sourcemodule WorkGroupNamesList : sig ... end

Sourcemodule CapacityAssignment : sig ... end

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

Sourcemodule CapacityAssignmentsList : sig ... end

Sourcemodule CapacityAssignmentConfiguration : sig ... end

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 TargetDpusInteger : sig ... end

Sourcemodule CapacityReservationStatus : sig ... end

Sourcemodule CapacityReservation : sig ... end

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 : sig ... end

Sourcemodule ParametersMapValue : sig ... end

Sourcemodule KeyString : sig ... end

Sourcemodule ParametersMap : sig ... end

Sourcemodule Classification : sig ... end

A classification refers to a set of specific configurations.

Sourcemodule ClassificationList : sig ... end

Sourcemodule ClientRequestToken : sig ... end

Sourcemodule LogTypeValue : sig ... end

Sourcemodule LogTypeValuesList : sig ... end

Sourcemodule LogTypeKey : sig ... end

Sourcemodule LogTypesMap : sig ... end

Sourcemodule LogStreamNamePrefix : sig ... end

Sourcemodule LogGroupName : sig ... end

Sourcemodule CloudWatchLoggingConfiguration : sig ... end

Configuration settings for delivering logs to Amazon CloudWatch log groups.

Sourcemodule TypeString : sig ... end

Sourcemodule CommentString : sig ... end

Sourcemodule Column : sig ... end

Contains metadata for a column in a table.

Sourcemodule ColumnNullable : sig ... end

Sourcemodule ColumnInfo : sig ... end

Information about the columns in a query execution result.

Sourcemodule ColumnInfoList : sig ... end

Sourcemodule ColumnList : sig ... end

Sourcemodule ConnectionType : sig ... end

Sourcemodule CoordinatorDpuSize : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule Tag : sig ... end

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 TagList : sig ... end

Sourcemodule CreateCapacityReservationInput : sig ... end

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

Sourcemodule CreateCapacityReservationOutput : sig ... end

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

Sourcemodule DataCatalogType : sig ... end

Sourcemodule CreateDataCatalogInput : sig ... end

Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account. 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 DataCatalogStatus : sig ... end

Sourcemodule DataCatalog : sig ... end

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 : sig ... end

Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account. 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 IdempotencyToken : sig ... end

Sourcemodule CreateNamedQueryInput : sig ... end

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

Sourcemodule CreateNamedQueryOutput : sig ... end

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

Sourcemodule NotebookName : sig ... end

Sourcemodule CreateNotebookInput : sig ... end

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

Sourcemodule ThrottleReason : sig ... end

Sourcemodule TooManyRequestsException : sig ... end

Indicates that the request was throttled.

Sourcemodule NotebookId : sig ... end

Sourcemodule CreateNotebookOutput : sig ... end

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

Sourcemodule CreatePreparedStatementInput : sig ... end

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

Sourcemodule CreatePreparedStatementOutput : sig ... end

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

Sourcemodule SessionId : sig ... end

Sourcemodule CreatePresignedNotebookUrlRequest : sig ... end

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

Sourcemodule ResourceNotFoundException : sig ... end

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

Sourcemodule CreatePresignedNotebookUrlResponse : sig ... end

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

Sourcemodule WorkGroupDescriptionString : sig ... end

Sourcemodule RoleArn : sig ... end

Sourcemodule S3OutputLocation : sig ... end

Sourcemodule S3LoggingConfiguration : sig ... end

Configuration settings for delivering logs to Amazon S3 buckets.

Sourcemodule ManagedLoggingConfiguration : sig ... end

Configuration settings for delivering logs to Amazon S3 buckets.

Sourcemodule MonitoringConfiguration : sig ... end

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

Sourcemodule IdentityCenterInstanceArn : sig ... end

Sourcemodule IdentityCenterConfiguration : sig ... end

Specifies whether the workgroup is IAM Identity Center supported.

Sourcemodule MaxConcurrentDpus : sig ... end

Sourcemodule DefaultExecutorDpuSize : sig ... end

Sourcemodule EngineConfiguration : sig ... end

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 : sig ... end

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 : sig ... end

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 : sig ... end

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

Sourcemodule CreateWorkGroupOutput : sig ... end

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

Sourcemodule DataCatalogSummary : sig ... end

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

Sourcemodule DataCatalogSummaryList : sig ... end

Sourcemodule Database : sig ... end

Contains metadata information for a database in a data catalog.

Sourcemodule DatabaseList : sig ... end

Sourcemodule DatumString : sig ... end

Sourcemodule Datum : sig ... end

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

Sourcemodule DeleteCapacityReservationInput : sig ... end

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

Sourcemodule DeleteCapacityReservationOutput : sig ... end

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

Sourcemodule DeleteDataCatalogInput : sig ... end

Deletes a data catalog.

Sourcemodule DeleteDataCatalogOutput : sig ... end

Deletes a data catalog.

Sourcemodule DeleteNamedQueryInput : sig ... end

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

Sourcemodule DeleteNamedQueryOutput : sig ... end

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

Sourcemodule DeleteNotebookInput : sig ... end

Deletes the specified notebook.

Sourcemodule DeleteNotebookOutput : sig ... end

Deletes the specified notebook.

Sourcemodule DeletePreparedStatementInput : sig ... end

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

Sourcemodule DeletePreparedStatementOutput : sig ... end

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

Sourcemodule DeleteWorkGroupInput : sig ... end

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

Sourcemodule DeleteWorkGroupOutput : sig ... end

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

Sourcemodule EngineVersionsList : sig ... end

Sourcemodule ExecutorId : sig ... end

Sourcemodule ExecutorState : sig ... end

Sourcemodule ExecutorType : sig ... end

Sourcemodule ExecutorsSummary : sig ... end

Contains summary information about an executor.

Sourcemodule ExecutorsSummaryList : sig ... end

Sourcemodule ExportNotebookInput : sig ... end

Exports the specified notebook and its metadata.

Sourcemodule Payload : sig ... end

Sourcemodule NotebookType : sig ... end

Sourcemodule NotebookMetadata : sig ... end

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

Sourcemodule ExportNotebookOutput : sig ... end

Exports the specified notebook and its metadata.

Sourcemodule ExpressionString : sig ... end

Sourcemodule FilterDefinition : sig ... end

A string for searching notebook names.

Sourcemodule GetCalculationExecutionCodeRequest : sig ... end

Retrieves the unencrypted code that was executed for the calculation.

Sourcemodule GetCalculationExecutionCodeResponse : sig ... end

Retrieves the unencrypted code that was executed for the calculation.

Sourcemodule GetCalculationExecutionRequest : sig ... end

Describes a previously submitted calculation execution.

Sourcemodule GetCalculationExecutionResponse : sig ... end

Describes a previously submitted calculation execution.

Sourcemodule GetCalculationExecutionStatusRequest : sig ... end

Gets the status of a current calculation.

Sourcemodule GetCalculationExecutionStatusResponse : sig ... end

Gets the status of a current calculation.

Sourcemodule GetCapacityAssignmentConfigurationInput : sig ... end

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

Sourcemodule GetCapacityAssignmentConfigurationOutput : sig ... end

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

Sourcemodule GetCapacityReservationInput : sig ... end

Returns information about the capacity reservation with the specified name.

Sourcemodule GetCapacityReservationOutput : sig ... end

Returns information about the capacity reservation with the specified name.

Sourcemodule GetDataCatalogInput : sig ... end

Returns the specified data catalog.

Sourcemodule GetDataCatalogOutput : sig ... end

Returns the specified data catalog.

Sourcemodule GetDatabaseInput : sig ... end

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

Sourcemodule MetadataException : sig ... end

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.

Sourcemodule GetDatabaseOutput : sig ... end

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

Sourcemodule GetNamedQueryInput : sig ... end

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

Sourcemodule GetNamedQueryOutput : sig ... end

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

Sourcemodule GetNotebookMetadataInput : sig ... end

Retrieves notebook metadata for the specified notebook ID.

Sourcemodule GetNotebookMetadataOutput : sig ... end

Retrieves notebook metadata for the specified notebook ID.

Sourcemodule GetPreparedStatementInput : sig ... end

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

Sourcemodule GetPreparedStatementOutput : sig ... end

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

Sourcemodule GetQueryExecutionInput : sig ... end

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

Sourcemodule GetQueryExecutionOutput : sig ... end

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

Sourcemodule Token : sig ... end

Sourcemodule QueryResultType : sig ... end

Sourcemodule MaxQueryResults : sig ... end

Sourcemodule GetQueryResultsInput : sig ... end

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query. 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 DatumList : sig ... end

Sourcemodule Row : sig ... end

The rows that make up a query result table.

Sourcemodule RowList : sig ... end

Sourcemodule ResultSetMetadata : sig ... end

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

Sourcemodule ResultSet : sig ... end

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 : sig ... end

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query. 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 : sig ... end

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

Sourcemodule StringList : sig ... end

module QueryStagePlanNode : sig ... end

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

module QueryStagePlanNodes : sig ... end

module QueryStage : sig ... end

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 : sig ... end

Sourcemodule QueryRuntimeStatisticsTimeline : sig ... end

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

Sourcemodule QueryRuntimeStatisticsRows : sig ... end

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 : sig ... end

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 : sig ... end

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

Sourcemodule GetResourceDashboardRequest : sig ... end

Gets the Live UI/Persistence UI for a session.

Sourcemodule GetResourceDashboardResponse : sig ... end

Gets the Live UI/Persistence UI for a session.

Sourcemodule GetSessionEndpointRequest : sig ... end

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

Sourcemodule GetSessionEndpointResponse : sig ... end

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

Sourcemodule GetSessionRequest : sig ... end

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

Sourcemodule SessionState : sig ... end

Sourcemodule SessionStatus : sig ... end

Contains information about the status of a session.

Sourcemodule SessionStatistics : sig ... end

Contains statistics for a session.

Sourcemodule SessionIdleTimeoutInMinutes : sig ... end

Sourcemodule SessionConfiguration : sig ... end

Contains session configuration information.

Sourcemodule GetSessionResponse : sig ... end

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

Sourcemodule GetSessionStatusRequest : sig ... end

Gets the current status of a session.

Sourcemodule GetSessionStatusResponse : sig ... end

Gets the current status of a session.

Sourcemodule GetTableMetadataInput : sig ... end

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

Sourcemodule TableTypeString : sig ... end

Sourcemodule TableMetadata : sig ... end

Contains metadata for a table.

Sourcemodule GetTableMetadataOutput : sig ... end

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

Sourcemodule GetWorkGroupInput : sig ... end

Returns information about the workgroup with the specified name.

Sourcemodule WorkGroupState : sig ... end

Sourcemodule IdentityCenterApplicationArn : sig ... end

Sourcemodule WorkGroup : sig ... end

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.

Sourcemodule GetWorkGroupOutput : sig ... end

Returns information about the workgroup with the specified name.

Sourcemodule ImportNotebookInput : sig ... end

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

Sourcemodule ImportNotebookOutput : sig ... end

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

Sourcemodule MaxApplicationDPUSizesCount : sig ... end

Sourcemodule ListApplicationDPUSizesInput : sig ... end

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

Sourcemodule ListApplicationDPUSizesOutput : sig ... end

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

Sourcemodule SessionManagerToken : sig ... end

Sourcemodule MaxCalculationsCount : sig ... end

Sourcemodule ListCalculationExecutionsRequest : sig ... end

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

Sourcemodule ListCalculationExecutionsResponse : sig ... end

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

Sourcemodule MaxCapacityReservationsCount : sig ... end

Sourcemodule ListCapacityReservationsInput : sig ... end

Lists the capacity reservations for the current account.

Sourcemodule ListCapacityReservationsOutput : sig ... end

Lists the capacity reservations for the current account.

Sourcemodule MaxDataCatalogsCount : sig ... end

Sourcemodule ListDataCatalogsInput : sig ... end

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 : sig ... end

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 MaxDatabasesCount : sig ... end

Sourcemodule ListDatabasesInput : sig ... end

Lists the databases in the specified data catalog.

Sourcemodule ListDatabasesOutput : sig ... end

Lists the databases in the specified data catalog.

Sourcemodule MaxEngineVersionsCount : sig ... end

Sourcemodule ListEngineVersionsInput : sig ... end

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

Sourcemodule ListEngineVersionsOutput : sig ... end

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

Sourcemodule MaxListExecutorsCount : sig ... end

Sourcemodule ListExecutorsRequest : sig ... end

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

Sourcemodule ListExecutorsResponse : sig ... end

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

Sourcemodule MaxNamedQueriesCount : sig ... end

Sourcemodule ListNamedQueriesInput : sig ... end

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

Sourcemodule ListNamedQueriesOutput : sig ... end

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

Sourcemodule MaxNotebooksCount : sig ... end

Sourcemodule ListNotebookMetadataInput : sig ... end

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

Sourcemodule NotebookMetadataArray : sig ... end

Sourcemodule ListNotebookMetadataOutput : sig ... end

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

Sourcemodule MaxSessionsCount : sig ... end

Sourcemodule ListNotebookSessionsRequest : sig ... end

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

Sourcemodule NotebookSessionSummary : sig ... end

Contains the notebook session ID and notebook session creation time.

Sourcemodule NotebookSessionsList : sig ... end

Sourcemodule ListNotebookSessionsResponse : sig ... end

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

Sourcemodule MaxPreparedStatementsCount : sig ... end

Sourcemodule ListPreparedStatementsInput : sig ... end

Lists the prepared statements in the specified workgroup.

Sourcemodule PreparedStatementSummary : sig ... end

The name and last modified time of the prepared statement.

Sourcemodule PreparedStatementsList : sig ... end

Sourcemodule ListPreparedStatementsOutput : sig ... end

Lists the prepared statements in the specified workgroup.

Sourcemodule MaxQueryExecutionsCount : sig ... end

Sourcemodule ListQueryExecutionsInput : sig ... end

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

Sourcemodule ListQueryExecutionsOutput : sig ... end

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

Sourcemodule ListSessionsRequest : sig ... end

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

Sourcemodule SessionSummary : sig ... end

Contains summary information about a session.

Sourcemodule SessionsList : sig ... end

Sourcemodule ListSessionsResponse : sig ... end

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

Sourcemodule MaxTableMetadataCount : sig ... end

Sourcemodule ListTableMetadataInput : sig ... end

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

Sourcemodule TableMetadataList : sig ... end

Sourcemodule ListTableMetadataOutput : sig ... end

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

Sourcemodule MaxTagsCount : sig ... end

Sourcemodule ListTagsForResourceInput : sig ... end

Lists the tags associated with an Athena resource.

Sourcemodule ListTagsForResourceOutput : sig ... end

Lists the tags associated with an Athena resource.

Sourcemodule MaxWorkGroupsCount : sig ... end

Sourcemodule ListWorkGroupsInput : sig ... end

Lists available workgroups for the account.

Sourcemodule WorkGroupSummary : sig ... end

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

Sourcemodule WorkGroupsList : sig ... end

Sourcemodule ListWorkGroupsOutput : sig ... end

Lists available workgroups for the account.

Sourcemodule ManagedQueryResultsConfigurationUpdates : sig ... end

Updates the configuration for managed query results.

Sourcemodule NamedQueryDescriptionString : sig ... end

Sourcemodule PutCapacityAssignmentConfigurationInput : sig ... end

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

Sourcemodule PutCapacityAssignmentConfigurationOutput : sig ... end

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

Sourcemodule ResultConfigurationUpdates : sig ... end

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

Sourcemodule SessionAlreadyExistsException : sig ... end

The specified session already exists.

Sourcemodule StartCalculationExecutionRequest : sig ... end

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 : sig ... end

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 : sig ... end

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

Sourcemodule StartQueryExecutionOutput : sig ... end

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

Sourcemodule StartSessionRequest : sig ... end

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

Sourcemodule StartSessionResponse : sig ... end

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

Sourcemodule StopCalculationExecutionRequest : sig ... end

Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect. 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 : sig ... end

Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect. 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 : sig ... end

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

Sourcemodule StopQueryExecutionOutput : sig ... end

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

Sourcemodule TagKeyList : sig ... end

Sourcemodule TagResourceInput : sig ... end

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

Sourcemodule TagResourceOutput : sig ... end

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

Sourcemodule TerminateSessionRequest : sig ... end

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

Sourcemodule TerminateSessionResponse : sig ... end

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

Sourcemodule UntagResourceInput : sig ... end

Removes one or more tags from an Athena resource.

Sourcemodule UntagResourceOutput : sig ... end

Removes one or more tags from an Athena resource.

Sourcemodule UpdateCapacityReservationInput : sig ... end

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

Sourcemodule UpdateCapacityReservationOutput : sig ... end

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

Sourcemodule UpdateDataCatalogInput : sig ... end

Updates the data catalog that has the specified name.

Sourcemodule UpdateDataCatalogOutput : sig ... end

Updates the data catalog that has the specified name.

Sourcemodule UpdateNamedQueryInput : sig ... end

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

Sourcemodule UpdateNamedQueryOutput : sig ... end

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

Sourcemodule UpdateNotebookInput : sig ... end

Updates the contents of a Spark notebook.

Sourcemodule UpdateNotebookMetadataInput : sig ... end

Updates the metadata for a notebook.

Sourcemodule UpdateNotebookMetadataOutput : sig ... end

Updates the metadata for a notebook.

Sourcemodule UpdateNotebookOutput : sig ... end

Updates the contents of a Spark notebook.

Sourcemodule UpdatePreparedStatementInput : sig ... end

Updates a prepared statement.

Sourcemodule UpdatePreparedStatementOutput : sig ... end

Updates a prepared statement.

Sourcemodule WorkGroupConfigurationUpdates : sig ... end

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 : sig ... end

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

Sourcemodule UpdateWorkGroupOutput : sig ... end

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