Athena

import { Athena } from "https://aws-api.deno.dev/v0.4/services/athena.ts?docs=full";

class Athena {

constructor(apiFactory: client.ApiFactory);

async batchGetNamedQuery(params: BatchGetNamedQueryInput, opts?: client.RequestOptions): Promise<BatchGetNamedQueryOutput>;

async batchGetPreparedStatement(params: BatchGetPreparedStatementInput, opts?: client.RequestOptions): Promise<BatchGetPreparedStatementOutput>;

async batchGetQueryExecution(params: BatchGetQueryExecutionInput, opts?: client.RequestOptions): Promise<BatchGetQueryExecutionOutput>;

async createDataCatalog(params: CreateDataCatalogInput, opts?: client.RequestOptions): Promise<void>;

async createNamedQuery(params: CreateNamedQueryInput, opts?: client.RequestOptions): Promise<CreateNamedQueryOutput>;

async createNotebook(params: CreateNotebookInput, opts?: client.RequestOptions): Promise<CreateNotebookOutput>;

async createPreparedStatement(params: CreatePreparedStatementInput, opts?: client.RequestOptions): Promise<void>;

async createPresignedNotebookUrl(params: CreatePresignedNotebookUrlRequest, opts?: client.RequestOptions): Promise<CreatePresignedNotebookUrlResponse>;

async createWorkGroup(params: CreateWorkGroupInput, opts?: client.RequestOptions): Promise<void>;

async deleteDataCatalog(params: DeleteDataCatalogInput, opts?: client.RequestOptions): Promise<void>;

async deleteNamedQuery(params: DeleteNamedQueryInput, opts?: client.RequestOptions): Promise<void>;

async deleteNotebook(params: DeleteNotebookInput, opts?: client.RequestOptions): Promise<void>;

async deletePreparedStatement(params: DeletePreparedStatementInput, opts?: client.RequestOptions): Promise<void>;

async deleteWorkGroup(params: DeleteWorkGroupInput, opts?: client.RequestOptions): Promise<void>;

async exportNotebook(params: ExportNotebookInput, opts?: client.RequestOptions): Promise<ExportNotebookOutput>;

async getCalculationExecution(params: GetCalculationExecutionRequest, opts?: client.RequestOptions): Promise<GetCalculationExecutionResponse>;

async getCalculationExecutionCode(params: GetCalculationExecutionCodeRequest, opts?: client.RequestOptions): Promise<GetCalculationExecutionCodeResponse>;

async getCalculationExecutionStatus(params: GetCalculationExecutionStatusRequest, opts?: client.RequestOptions): Promise<GetCalculationExecutionStatusResponse>;

async getDatabase(params: GetDatabaseInput, opts?: client.RequestOptions): Promise<GetDatabaseOutput>;

async getDataCatalog(params: GetDataCatalogInput, opts?: client.RequestOptions): Promise<GetDataCatalogOutput>;

async getNamedQuery(params: GetNamedQueryInput, opts?: client.RequestOptions): Promise<GetNamedQueryOutput>;

async getNotebookMetadata(params: GetNotebookMetadataInput, opts?: client.RequestOptions): Promise<GetNotebookMetadataOutput>;

async getPreparedStatement(params: GetPreparedStatementInput, opts?: client.RequestOptions): Promise<GetPreparedStatementOutput>;

async getQueryExecution(params: GetQueryExecutionInput, opts?: client.RequestOptions): Promise<GetQueryExecutionOutput>;

async getQueryResults(params: GetQueryResultsInput, opts?: client.RequestOptions): Promise<GetQueryResultsOutput>;

async getQueryRuntimeStatistics(params: GetQueryRuntimeStatisticsInput, opts?: client.RequestOptions): Promise<GetQueryRuntimeStatisticsOutput>;

async getSession(params: GetSessionRequest, opts?: client.RequestOptions): Promise<GetSessionResponse>;

async getSessionStatus(params: GetSessionStatusRequest, opts?: client.RequestOptions): Promise<GetSessionStatusResponse>;

async getTableMetadata(params: GetTableMetadataInput, opts?: client.RequestOptions): Promise<GetTableMetadataOutput>;

async getWorkGroup(params: GetWorkGroupInput, opts?: client.RequestOptions): Promise<GetWorkGroupOutput>;

async importNotebook(params: ImportNotebookInput, opts?: client.RequestOptions): Promise<ImportNotebookOutput>;

async listApplicationDPUSizes(params?: ListApplicationDPUSizesInput, opts?: client.RequestOptions): Promise<ListApplicationDPUSizesOutput>;

async listCalculationExecutions(params: ListCalculationExecutionsRequest, opts?: client.RequestOptions): Promise<ListCalculationExecutionsResponse>;

async listDatabases(params: ListDatabasesInput, opts?: client.RequestOptions): Promise<ListDatabasesOutput>;

async listDataCatalogs(params?: ListDataCatalogsInput, opts?: client.RequestOptions): Promise<ListDataCatalogsOutput>;

async listEngineVersions(params?: ListEngineVersionsInput, opts?: client.RequestOptions): Promise<ListEngineVersionsOutput>;

async listExecutors(params: ListExecutorsRequest, opts?: client.RequestOptions): Promise<ListExecutorsResponse>;

async listNamedQueries(params?: ListNamedQueriesInput, opts?: client.RequestOptions): Promise<ListNamedQueriesOutput>;

async listNotebookMetadata(params: ListNotebookMetadataInput, opts?: client.RequestOptions): Promise<ListNotebookMetadataOutput>;

async listNotebookSessions(params: ListNotebookSessionsRequest, opts?: client.RequestOptions): Promise<ListNotebookSessionsResponse>;

async listPreparedStatements(params: ListPreparedStatementsInput, opts?: client.RequestOptions): Promise<ListPreparedStatementsOutput>;

async listQueryExecutions(params?: ListQueryExecutionsInput, opts?: client.RequestOptions): Promise<ListQueryExecutionsOutput>;

async listSessions(params: ListSessionsRequest, opts?: client.RequestOptions): Promise<ListSessionsResponse>;

async listTableMetadata(params: ListTableMetadataInput, opts?: client.RequestOptions): Promise<ListTableMetadataOutput>;

async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;

async listWorkGroups(params?: ListWorkGroupsInput, opts?: client.RequestOptions): Promise<ListWorkGroupsOutput>;

async startCalculationExecution(params: StartCalculationExecutionRequest, opts?: client.RequestOptions): Promise<StartCalculationExecutionResponse>;

async startQueryExecution(params: StartQueryExecutionInput, opts?: client.RequestOptions): Promise<StartQueryExecutionOutput>;

async startSession(params: StartSessionRequest, opts?: client.RequestOptions): Promise<StartSessionResponse>;

async stopCalculationExecution(params: StopCalculationExecutionRequest, opts?: client.RequestOptions): Promise<StopCalculationExecutionResponse>;

async stopQueryExecution(params: StopQueryExecutionInput, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;

async terminateSession(params: TerminateSessionRequest, opts?: client.RequestOptions): Promise<TerminateSessionResponse>;

async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;

async updateDataCatalog(params: UpdateDataCatalogInput, opts?: client.RequestOptions): Promise<void>;

async updateNamedQuery(params: UpdateNamedQueryInput, opts?: client.RequestOptions): Promise<void>;

async updateNotebook(params: UpdateNotebookInput, opts?: client.RequestOptions): Promise<void>;

async updateNotebookMetadata(params: UpdateNotebookMetadataInput, opts?: client.RequestOptions): Promise<void>;

async updatePreparedStatement(params: UpdatePreparedStatementInput, opts?: client.RequestOptions): Promise<void>;

async updateWorkGroup(params: UpdateWorkGroupInput, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Athena(apiFactory: client.ApiFactory)

[src]

§Methods

batchGetNamedQuery(params: BatchGetNamedQueryInput, opts?: client.RequestOptions): Promise<BatchGetNamedQueryOutput>

[src]

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.

batchGetPreparedStatement(params: BatchGetPreparedStatementInput, opts?: client.RequestOptions): Promise<BatchGetPreparedStatementOutput>

[src]

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.

batchGetQueryExecution(params: BatchGetQueryExecutionInput, opts?: client.RequestOptions): Promise<BatchGetQueryExecutionOutput>

[src]

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.

createDataCatalog(params: CreateDataCatalogInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

createNamedQuery(params: CreateNamedQueryInput, opts?: client.RequestOptions): Promise<CreateNamedQueryOutput>

[src]

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

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

createNotebook(params: CreateNotebookInput, opts?: client.RequestOptions): Promise<CreateNotebookOutput>

[src]

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.

createPreparedStatement(params: CreatePreparedStatementInput, opts?: client.RequestOptions): Promise<void>

[src]

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

createPresignedNotebookUrl(params: CreatePresignedNotebookUrlRequest, opts?: client.RequestOptions): Promise<CreatePresignedNotebookUrlResponse>

[src]

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.

createWorkGroup(params: CreateWorkGroupInput, opts?: client.RequestOptions): Promise<void>

[src]

Creates a workgroup with the specified name. Only one of Configurations or Configuration can be specified; Configurations for a workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or Configuration for an Athena SQL workgroup.

deleteDataCatalog(params: DeleteDataCatalogInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a data catalog.

deleteNamedQuery(params: DeleteNamedQueryInput, opts?: client.RequestOptions): Promise<void>

[src]

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

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

deleteNotebook(params: DeleteNotebookInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified notebook.

deletePreparedStatement(params: DeletePreparedStatementInput, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteWorkGroup(params: DeleteWorkGroupInput, opts?: client.RequestOptions): Promise<void>

[src]

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

exportNotebook(params: ExportNotebookInput, opts?: client.RequestOptions): Promise<ExportNotebookOutput>

[src]

Exports the specified notebook and its metadata.

getCalculationExecution(params: GetCalculationExecutionRequest, opts?: client.RequestOptions): Promise<GetCalculationExecutionResponse>

[src]

Describes a previously submitted calculation execution.

getCalculationExecutionCode(params: GetCalculationExecutionCodeRequest, opts?: client.RequestOptions): Promise<GetCalculationExecutionCodeResponse>

[src]

Retrieves a pre-signed URL to a copy of the code that was executed for the calculation.

getCalculationExecutionStatus(params: GetCalculationExecutionStatusRequest, opts?: client.RequestOptions): Promise<GetCalculationExecutionStatusResponse>

[src]

Gets the status of a current calculation.

getDatabase(params: GetDatabaseInput, opts?: client.RequestOptions): Promise<GetDatabaseOutput>

[src]

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

getDataCatalog(params: GetDataCatalogInput, opts?: client.RequestOptions): Promise<GetDataCatalogOutput>

[src]

Returns the specified data catalog.

getNamedQuery(params: GetNamedQueryInput, opts?: client.RequestOptions): Promise<GetNamedQueryOutput>

[src]

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

getNotebookMetadata(params: GetNotebookMetadataInput, opts?: client.RequestOptions): Promise<GetNotebookMetadataOutput>

[src]

Retrieves notebook metadata for the specified notebook ID.

getPreparedStatement(params: GetPreparedStatementInput, opts?: client.RequestOptions): Promise<GetPreparedStatementOutput>

[src]

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

getQueryExecution(params: GetQueryExecutionInput, opts?: client.RequestOptions): Promise<GetQueryExecutionOutput>

[src]

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.

getQueryResults(params: GetQueryResultsInput, opts?: client.RequestOptions): Promise<GetQueryResultsOutput>

[src]

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results 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.

! IMPORTANT: ! 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.

getQueryRuntimeStatistics(params: GetQueryRuntimeStatisticsInput, opts?: client.RequestOptions): Promise<GetQueryRuntimeStatisticsOutput>

[src]

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. Query execution runtime statistics are returned only when "QueryExecutionStatus$State" is in a SUCCEEDED or FAILED state. Stage-level input and output row count and data size statistics are not shown when a query has row-level filters defined in Lake Formation.

getSession(params: GetSessionRequest, opts?: client.RequestOptions): Promise<GetSessionResponse>

[src]

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

getSessionStatus(params: GetSessionStatusRequest, opts?: client.RequestOptions): Promise<GetSessionStatusResponse>

[src]

Gets the current status of a session.

getTableMetadata(params: GetTableMetadataInput, opts?: client.RequestOptions): Promise<GetTableMetadataOutput>

[src]

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

getWorkGroup(params: GetWorkGroupInput, opts?: client.RequestOptions): Promise<GetWorkGroupOutput>

[src]

Returns information about the workgroup with the specified name.

importNotebook(params: ImportNotebookInput, opts?: client.RequestOptions): Promise<ImportNotebookOutput>

[src]

Imports a single ipynb file to a Spark enabled workgroup. 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.

listApplicationDPUSizes(params?: ListApplicationDPUSizesInput, opts?: client.RequestOptions): Promise<ListApplicationDPUSizesOutput>

[src]

Returns the supported DPU sizes for the supported application runtimes (for example, Jupyter 1.0).

listCalculationExecutions(params: ListCalculationExecutionsRequest, opts?: client.RequestOptions): Promise<ListCalculationExecutionsResponse>

[src]

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

listDatabases(params: ListDatabasesInput, opts?: client.RequestOptions): Promise<ListDatabasesOutput>

[src]

Lists the databases in the specified data catalog.

listDataCatalogs(params?: ListDataCatalogsInput, opts?: client.RequestOptions): Promise<ListDataCatalogsOutput>

[src]

Lists the data catalogs in the current Amazon Web Services account.

listEngineVersions(params?: ListEngineVersionsInput, opts?: client.RequestOptions): Promise<ListEngineVersionsOutput>

[src]

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

listExecutors(params: ListExecutorsRequest, opts?: client.RequestOptions): Promise<ListExecutorsResponse>

[src]

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

listNamedQueries(params?: ListNamedQueriesInput, opts?: client.RequestOptions): Promise<ListNamedQueriesOutput>

[src]

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.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

listNotebookMetadata(params: ListNotebookMetadataInput, opts?: client.RequestOptions): Promise<ListNotebookMetadataOutput>

[src]

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

listNotebookSessions(params: ListNotebookSessionsRequest, opts?: client.RequestOptions): Promise<ListNotebookSessionsResponse>

[src]

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.

listPreparedStatements(params: ListPreparedStatementsInput, opts?: client.RequestOptions): Promise<ListPreparedStatementsOutput>

[src]

Lists the prepared statements in the specified workgroup.

listQueryExecutions(params?: ListQueryExecutionsInput, opts?: client.RequestOptions): Promise<ListQueryExecutionsOutput>

[src]

Provides a list of available query execution IDs for the queries in the specified workgroup. 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.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

listSessions(params: ListSessionsRequest, opts?: client.RequestOptions): Promise<ListSessionsResponse>

[src]

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.

listTableMetadata(params: ListTableMetadataInput, opts?: client.RequestOptions): Promise<ListTableMetadataOutput>

[src]

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

listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>

[src]

Lists the tags associated with an Athena workgroup or data catalog resource.

listWorkGroups(params?: ListWorkGroupsInput, opts?: client.RequestOptions): Promise<ListWorkGroupsOutput>

[src]

Lists available workgroups for the account.

startCalculationExecution(params: StartCalculationExecutionRequest, opts?: client.RequestOptions): Promise<StartCalculationExecutionResponse>

[src]

Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request or as an Amazon S3 URL.

startQueryExecution(params: StartQueryExecutionInput, opts?: client.RequestOptions): Promise<StartQueryExecutionOutput>

[src]

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.

startSession(params: StartSessionRequest, opts?: client.RequestOptions): Promise<StartSessionResponse>

[src]

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

stopCalculationExecution(params: StopCalculationExecutionRequest, opts?: client.RequestOptions): Promise<StopCalculationExecutionResponse>

[src]

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.

Note: 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.

stopQueryExecution(params: StopQueryExecutionInput, opts?: client.RequestOptions): Promise<void>

[src]

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

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

Adds one or more tags to an Athena resource. A tag is 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.

terminateSession(params: TerminateSessionRequest, opts?: client.RequestOptions): Promise<TerminateSessionResponse>

[src]

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.

untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

Removes one or more tags from a data catalog or workgroup resource.

updateDataCatalog(params: UpdateDataCatalogInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates the data catalog that has the specified name.

updateNamedQuery(params: UpdateNamedQueryInput, opts?: client.RequestOptions): Promise<void>

[src]

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

updateNotebook(params: UpdateNotebookInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates the contents of a Spark notebook.

updateNotebookMetadata(params: UpdateNotebookMetadataInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates the metadata for a notebook.

updatePreparedStatement(params: UpdatePreparedStatementInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates a prepared statement.

updateWorkGroup(params: UpdateWorkGroupInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only one of ConfigurationsUpdates or ConfigurationUpdates can be specified; ConfigurationsUpdates for a workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or ConfigurationUpdates for an Athena SQL workgroup.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]