Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/athena.ts?docs=full";

§Classes

Athena

§Interfaces

BatchGetNamedQueryInput
BatchGetNamedQueryOutput
BatchGetQueryExecutionInput
BatchGetQueryExecutionOutput
Column

Contains metadata for a column in a table.

ColumnInfo

Information about the columns in a query execution result.

CreateDataCatalogInput
CreateNamedQueryInput
CreateNamedQueryOutput
CreatePreparedStatementInput
CreateWorkGroupInput
Database

Contains metadata information for a database in a data catalog.

DataCatalog

Contains information about a data catalog in an Amazon Web Services account.

DataCatalogSummary

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

Datum

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

DeleteDataCatalogInput
DeleteNamedQueryInput
DeletePreparedStatementInput
DeleteWorkGroupInput
EncryptionConfiguration

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.

EngineVersion

The Athena engine version for running queries.

GetDatabaseInput
GetDatabaseOutput
GetDataCatalogInput
GetDataCatalogOutput
GetNamedQueryInput
GetNamedQueryOutput
GetPreparedStatementInput
GetPreparedStatementOutput
GetQueryExecutionInput
GetQueryExecutionOutput
GetQueryResultsInput
GetQueryResultsOutput
GetTableMetadataInput
GetTableMetadataOutput
GetWorkGroupInput
GetWorkGroupOutput
ListDatabasesInput
ListDatabasesOutput
ListDataCatalogsInput
ListDataCatalogsOutput
ListEngineVersionsInput
ListEngineVersionsOutput
ListNamedQueriesInput
ListNamedQueriesOutput
ListPreparedStatementsInput
ListPreparedStatementsOutput
ListQueryExecutionsInput
ListQueryExecutionsOutput
ListTableMetadataInput
ListTableMetadataOutput
ListTagsForResourceInput
ListTagsForResourceOutput
ListWorkGroupsInput
ListWorkGroupsOutput
NamedQuery

A query, where QueryString is the list of SQL query statements that comprise the query.

PreparedStatement

A prepared SQL statement for use with Athena.

PreparedStatementSummary

The name and last modified time of the prepared statement.

QueryExecution

Information about a single instance of a query execution.

QueryExecutionContext

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

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.

QueryExecutionStatus

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

ResultConfiguration

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

ResultConfigurationUpdates

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

ResultSet

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

ResultSetMetadata

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

Row

The rows that comprise a query result table.

StartQueryExecutionInput
StartQueryExecutionOutput
StopQueryExecutionInput
TableMetadata

Contains metadata for a table.

Tag

A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. 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 or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs 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.

TagResourceInput
UnprocessedNamedQueryId

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

UnprocessedQueryExecutionId

Describes a query execution that failed to process.

UntagResourceInput
UpdateDataCatalogInput
UpdatePreparedStatementInput
UpdateWorkGroupInput
WorkGroup

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".

WorkGroupConfiguration

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query 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".

WorkGroupConfigurationUpdates

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query 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.

WorkGroupSummary

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

§Type Aliases

ColumnNullable
DataCatalogType
EncryptionOption
QueryExecutionState
StatementType
WorkGroupState