Athena

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

class Athena {

constructor(apiFactory: client.ApiFactory);

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

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 createPreparedStatement(params: CreatePreparedStatementInput, opts?: client.RequestOptions): Promise<void>;

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 deletePreparedStatement(params: DeletePreparedStatementInput, opts?: client.RequestOptions): Promise<void>;

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

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 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 getTableMetadata(params: GetTableMetadataInput, opts?: client.RequestOptions): Promise<GetTableMetadataOutput>;

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

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 listNamedQueries(params?: ListNamedQueriesInput, opts?: client.RequestOptions): Promise<ListNamedQueriesOutput>;

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

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

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 startQueryExecution(params: StartQueryExecutionInput, opts?: client.RequestOptions): Promise<StartQueryExecutionOutput>;

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

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

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

async updateDataCatalog(params: UpdateDataCatalogInput, 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.

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.

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

[src]

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

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

[src]

Creates a workgroup with the specified name.

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.

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.

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.

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.

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.

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.

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.

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

[src]

Lists the prepared statements in the specfied 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.

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.

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.

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.

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.

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]