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.4/services/athena.ts?docs=full";

§Classes

Athena

§Interfaces

AclConfiguration

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. 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.

ApplicationDPUSizes

Contains the application runtime IDs and their supported DPU sizes.

AthenaError

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.

BatchGetNamedQueryInput

Contains an array of named query IDs.

BatchGetNamedQueryOutput
BatchGetPreparedStatementInput
BatchGetPreparedStatementOutput
BatchGetQueryExecutionInput

Contains an array of query execution IDs.

BatchGetQueryExecutionOutput
CalculationConfiguration

Contains configuration information for the calculation.

CalculationResult

Contains information about an application-specific calculation result.

CalculationStatistics

Contains statistics for a notebook calculation.

CalculationStatus

Contains information about the status of a notebook calculation.

CalculationSummary

Summary information for a notebook calculation.

Column

Contains metadata for a column in a table.

ColumnInfo

Information about the columns in a query execution result.

CreateDataCatalogInput
CreateNamedQueryInput
CreateNamedQueryOutput
CreateNotebookInput
CreateNotebookOutput
CreatePreparedStatementInput
CreatePresignedNotebookUrlRequest
CreatePresignedNotebookUrlResponse
CreateWorkGroupInput
CustomerContentEncryptionConfiguration

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

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

EngineConfiguration

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

EngineVersion

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

ExecutorsSummary

Contains summary information about an executor.

ExportNotebookInput
ExportNotebookOutput
FilterDefinition

A string for searching notebook names.

GetCalculationExecutionCodeRequest
GetCalculationExecutionCodeResponse
GetCalculationExecutionRequest
GetCalculationExecutionResponse
GetCalculationExecutionStatusRequest
GetCalculationExecutionStatusResponse
GetDatabaseInput
GetDatabaseOutput
GetDataCatalogInput
GetDataCatalogOutput
GetNamedQueryInput
GetNamedQueryOutput
GetNotebookMetadataInput
GetNotebookMetadataOutput
GetPreparedStatementInput
GetPreparedStatementOutput
GetQueryExecutionInput
GetQueryExecutionOutput
GetQueryResultsInput
GetQueryResultsOutput
GetQueryRuntimeStatisticsInput
GetQueryRuntimeStatisticsOutput
GetSessionRequest
GetSessionResponse
GetSessionStatusRequest
GetSessionStatusResponse
GetTableMetadataInput
GetTableMetadataOutput
GetWorkGroupInput
GetWorkGroupOutput
ImportNotebookInput
ImportNotebookOutput
ListApplicationDPUSizesInput
ListApplicationDPUSizesOutput
ListCalculationExecutionsRequest
ListCalculationExecutionsResponse
ListDatabasesInput
ListDatabasesOutput
ListDataCatalogsInput
ListDataCatalogsOutput
ListEngineVersionsInput
ListEngineVersionsOutput
ListExecutorsRequest
ListExecutorsResponse
ListNamedQueriesInput
ListNamedQueriesOutput
ListNotebookMetadataInput
ListNotebookMetadataOutput
ListNotebookSessionsRequest
ListNotebookSessionsResponse
ListPreparedStatementsInput
ListPreparedStatementsOutput
ListQueryExecutionsInput
ListQueryExecutionsOutput
ListSessionsRequest
ListSessionsResponse
ListTableMetadataInput
ListTableMetadataOutput
ListTagsForResourceInput
ListTagsForResourceOutput
ListWorkGroupsInput
ListWorkGroupsOutput
NamedQuery

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

NotebookMetadata

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

NotebookSessionSummary

Contains the notebook session ID and notebook session creation time.

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.

QueryRuntimeStatistics

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

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.

QueryRuntimeStatisticsTimeline

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

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.

QueryStagePlanNode

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

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.

ResultReuseByAgeConfiguration

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

ResultReuseConfiguration

Specifies the query result reuse behavior for the query.

ResultReuseInformation

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

ResultSet

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

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 make up a query result table.

SessionConfiguration

Contains session configuration information.

SessionStatistics

Contains statistics for a notebook session.

SessionStatus

Contains information about the status of a notebook session.

SessionSummary

Contains summary information about a notebook session.

StartCalculationExecutionRequest
StartCalculationExecutionResponse
StartQueryExecutionInput
StartQueryExecutionOutput
StartSessionRequest
StartSessionResponse
StopCalculationExecutionRequest
StopCalculationExecutionResponse
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
TerminateSessionRequest
TerminateSessionResponse
UnprocessedNamedQueryId

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

UnprocessedPreparedStatementName

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

UnprocessedQueryExecutionId

Describes a query execution that failed to process.

UntagResourceInput
UpdateDataCatalogInput
UpdateNamedQueryInput
UpdateNotebookInput
UpdateNotebookMetadataInput
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

CalculationExecutionState
ColumnNullable
DataCatalogType
EncryptionOption
ExecutorState
ExecutorType
NotebookType
QueryExecutionState
S3AclOption
SessionState
StatementType
WorkGroupState