@alma-cdk/cross-region-parameter
Version:
Store AWS SSM Parameter Store Parameters into another AWS Region with AWS CDK
839 lines • 94 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Athena extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Athena.Types.ClientConfiguration)
config: Config & Athena.Types.ClientConfiguration;
/**
* 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.
*/
batchGetNamedQuery(params: Athena.Types.BatchGetNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.BatchGetNamedQueryOutput) => void): Request<Athena.Types.BatchGetNamedQueryOutput, AWSError>;
/**
* 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.
*/
batchGetNamedQuery(callback?: (err: AWSError, data: Athena.Types.BatchGetNamedQueryOutput) => void): Request<Athena.Types.BatchGetNamedQueryOutput, AWSError>;
/**
* 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.
*/
batchGetPreparedStatement(params: Athena.Types.BatchGetPreparedStatementInput, callback?: (err: AWSError, data: Athena.Types.BatchGetPreparedStatementOutput) => void): Request<Athena.Types.BatchGetPreparedStatementOutput, AWSError>;
/**
* 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.
*/
batchGetPreparedStatement(callback?: (err: AWSError, data: Athena.Types.BatchGetPreparedStatementOutput) => void): Request<Athena.Types.BatchGetPreparedStatementOutput, AWSError>;
/**
* 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.
*/
batchGetQueryExecution(params: Athena.Types.BatchGetQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.BatchGetQueryExecutionOutput) => void): Request<Athena.Types.BatchGetQueryExecutionOutput, AWSError>;
/**
* 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.
*/
batchGetQueryExecution(callback?: (err: AWSError, data: Athena.Types.BatchGetQueryExecutionOutput) => void): Request<Athena.Types.BatchGetQueryExecutionOutput, AWSError>;
/**
* 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.
*/
createDataCatalog(params: Athena.Types.CreateDataCatalogInput, callback?: (err: AWSError, data: Athena.Types.CreateDataCatalogOutput) => void): Request<Athena.Types.CreateDataCatalogOutput, AWSError>;
/**
* 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.
*/
createDataCatalog(callback?: (err: AWSError, data: Athena.Types.CreateDataCatalogOutput) => void): Request<Athena.Types.CreateDataCatalogOutput, AWSError>;
/**
* 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.
*/
createNamedQuery(params: Athena.Types.CreateNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.CreateNamedQueryOutput) => void): Request<Athena.Types.CreateNamedQueryOutput, AWSError>;
/**
* 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.
*/
createNamedQuery(callback?: (err: AWSError, data: Athena.Types.CreateNamedQueryOutput) => void): Request<Athena.Types.CreateNamedQueryOutput, AWSError>;
/**
* Creates a prepared statement for use with SQL queries in Athena.
*/
createPreparedStatement(params: Athena.Types.CreatePreparedStatementInput, callback?: (err: AWSError, data: Athena.Types.CreatePreparedStatementOutput) => void): Request<Athena.Types.CreatePreparedStatementOutput, AWSError>;
/**
* Creates a prepared statement for use with SQL queries in Athena.
*/
createPreparedStatement(callback?: (err: AWSError, data: Athena.Types.CreatePreparedStatementOutput) => void): Request<Athena.Types.CreatePreparedStatementOutput, AWSError>;
/**
* Creates a workgroup with the specified name.
*/
createWorkGroup(params: Athena.Types.CreateWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.CreateWorkGroupOutput) => void): Request<Athena.Types.CreateWorkGroupOutput, AWSError>;
/**
* Creates a workgroup with the specified name.
*/
createWorkGroup(callback?: (err: AWSError, data: Athena.Types.CreateWorkGroupOutput) => void): Request<Athena.Types.CreateWorkGroupOutput, AWSError>;
/**
* Deletes a data catalog.
*/
deleteDataCatalog(params: Athena.Types.DeleteDataCatalogInput, callback?: (err: AWSError, data: Athena.Types.DeleteDataCatalogOutput) => void): Request<Athena.Types.DeleteDataCatalogOutput, AWSError>;
/**
* Deletes a data catalog.
*/
deleteDataCatalog(callback?: (err: AWSError, data: Athena.Types.DeleteDataCatalogOutput) => void): Request<Athena.Types.DeleteDataCatalogOutput, AWSError>;
/**
* 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.
*/
deleteNamedQuery(params: Athena.Types.DeleteNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.DeleteNamedQueryOutput) => void): Request<Athena.Types.DeleteNamedQueryOutput, AWSError>;
/**
* 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.
*/
deleteNamedQuery(callback?: (err: AWSError, data: Athena.Types.DeleteNamedQueryOutput) => void): Request<Athena.Types.DeleteNamedQueryOutput, AWSError>;
/**
* Deletes the prepared statement with the specified name from the specified workgroup.
*/
deletePreparedStatement(params: Athena.Types.DeletePreparedStatementInput, callback?: (err: AWSError, data: Athena.Types.DeletePreparedStatementOutput) => void): Request<Athena.Types.DeletePreparedStatementOutput, AWSError>;
/**
* Deletes the prepared statement with the specified name from the specified workgroup.
*/
deletePreparedStatement(callback?: (err: AWSError, data: Athena.Types.DeletePreparedStatementOutput) => void): Request<Athena.Types.DeletePreparedStatementOutput, AWSError>;
/**
* Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
*/
deleteWorkGroup(params: Athena.Types.DeleteWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.DeleteWorkGroupOutput) => void): Request<Athena.Types.DeleteWorkGroupOutput, AWSError>;
/**
* Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
*/
deleteWorkGroup(callback?: (err: AWSError, data: Athena.Types.DeleteWorkGroupOutput) => void): Request<Athena.Types.DeleteWorkGroupOutput, AWSError>;
/**
* Returns the specified data catalog.
*/
getDataCatalog(params: Athena.Types.GetDataCatalogInput, callback?: (err: AWSError, data: Athena.Types.GetDataCatalogOutput) => void): Request<Athena.Types.GetDataCatalogOutput, AWSError>;
/**
* Returns the specified data catalog.
*/
getDataCatalog(callback?: (err: AWSError, data: Athena.Types.GetDataCatalogOutput) => void): Request<Athena.Types.GetDataCatalogOutput, AWSError>;
/**
* Returns a database object for the specified database and data catalog.
*/
getDatabase(params: Athena.Types.GetDatabaseInput, callback?: (err: AWSError, data: Athena.Types.GetDatabaseOutput) => void): Request<Athena.Types.GetDatabaseOutput, AWSError>;
/**
* Returns a database object for the specified database and data catalog.
*/
getDatabase(callback?: (err: AWSError, data: Athena.Types.GetDatabaseOutput) => void): Request<Athena.Types.GetDatabaseOutput, AWSError>;
/**
* Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
*/
getNamedQuery(params: Athena.Types.GetNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.GetNamedQueryOutput) => void): Request<Athena.Types.GetNamedQueryOutput, AWSError>;
/**
* Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
*/
getNamedQuery(callback?: (err: AWSError, data: Athena.Types.GetNamedQueryOutput) => void): Request<Athena.Types.GetNamedQueryOutput, AWSError>;
/**
* Retrieves the prepared statement with the specified name from the specified workgroup.
*/
getPreparedStatement(params: Athena.Types.GetPreparedStatementInput, callback?: (err: AWSError, data: Athena.Types.GetPreparedStatementOutput) => void): Request<Athena.Types.GetPreparedStatementOutput, AWSError>;
/**
* Retrieves the prepared statement with the specified name from the specified workgroup.
*/
getPreparedStatement(callback?: (err: AWSError, data: Athena.Types.GetPreparedStatementOutput) => void): Request<Athena.Types.GetPreparedStatementOutput, AWSError>;
/**
* 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.
*/
getQueryExecution(params: Athena.Types.GetQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.GetQueryExecutionOutput) => void): Request<Athena.Types.GetQueryExecutionOutput, AWSError>;
/**
* 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.
*/
getQueryExecution(callback?: (err: AWSError, data: Athena.Types.GetQueryExecutionOutput) => void): Request<Athena.Types.GetQueryExecutionOutput, AWSError>;
/**
* 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. 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.
*/
getQueryResults(params: Athena.Types.GetQueryResultsInput, callback?: (err: AWSError, data: Athena.Types.GetQueryResultsOutput) => void): Request<Athena.Types.GetQueryResultsOutput, AWSError>;
/**
* 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. 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.
*/
getQueryResults(callback?: (err: AWSError, data: Athena.Types.GetQueryResultsOutput) => void): Request<Athena.Types.GetQueryResultsOutput, AWSError>;
/**
* 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. The query execution runtime statistics is returned only when QueryExecutionStatus$State is in a SUCCEEDED or FAILED state.
*/
getQueryRuntimeStatistics(params: Athena.Types.GetQueryRuntimeStatisticsInput, callback?: (err: AWSError, data: Athena.Types.GetQueryRuntimeStatisticsOutput) => void): Request<Athena.Types.GetQueryRuntimeStatisticsOutput, AWSError>;
/**
* 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. The query execution runtime statistics is returned only when QueryExecutionStatus$State is in a SUCCEEDED or FAILED state.
*/
getQueryRuntimeStatistics(callback?: (err: AWSError, data: Athena.Types.GetQueryRuntimeStatisticsOutput) => void): Request<Athena.Types.GetQueryRuntimeStatisticsOutput, AWSError>;
/**
* Returns table metadata for the specified catalog, database, and table.
*/
getTableMetadata(params: Athena.Types.GetTableMetadataInput, callback?: (err: AWSError, data: Athena.Types.GetTableMetadataOutput) => void): Request<Athena.Types.GetTableMetadataOutput, AWSError>;
/**
* Returns table metadata for the specified catalog, database, and table.
*/
getTableMetadata(callback?: (err: AWSError, data: Athena.Types.GetTableMetadataOutput) => void): Request<Athena.Types.GetTableMetadataOutput, AWSError>;
/**
* Returns information about the workgroup with the specified name.
*/
getWorkGroup(params: Athena.Types.GetWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.GetWorkGroupOutput) => void): Request<Athena.Types.GetWorkGroupOutput, AWSError>;
/**
* Returns information about the workgroup with the specified name.
*/
getWorkGroup(callback?: (err: AWSError, data: Athena.Types.GetWorkGroupOutput) => void): Request<Athena.Types.GetWorkGroupOutput, AWSError>;
/**
* Lists the data catalogs in the current Amazon Web Services account.
*/
listDataCatalogs(params: Athena.Types.ListDataCatalogsInput, callback?: (err: AWSError, data: Athena.Types.ListDataCatalogsOutput) => void): Request<Athena.Types.ListDataCatalogsOutput, AWSError>;
/**
* Lists the data catalogs in the current Amazon Web Services account.
*/
listDataCatalogs(callback?: (err: AWSError, data: Athena.Types.ListDataCatalogsOutput) => void): Request<Athena.Types.ListDataCatalogsOutput, AWSError>;
/**
* Lists the databases in the specified data catalog.
*/
listDatabases(params: Athena.Types.ListDatabasesInput, callback?: (err: AWSError, data: Athena.Types.ListDatabasesOutput) => void): Request<Athena.Types.ListDatabasesOutput, AWSError>;
/**
* Lists the databases in the specified data catalog.
*/
listDatabases(callback?: (err: AWSError, data: Athena.Types.ListDatabasesOutput) => void): Request<Athena.Types.ListDatabasesOutput, AWSError>;
/**
* Returns a list of engine versions that are available to choose from, including the Auto option.
*/
listEngineVersions(params: Athena.Types.ListEngineVersionsInput, callback?: (err: AWSError, data: Athena.Types.ListEngineVersionsOutput) => void): Request<Athena.Types.ListEngineVersionsOutput, AWSError>;
/**
* Returns a list of engine versions that are available to choose from, including the Auto option.
*/
listEngineVersions(callback?: (err: AWSError, data: Athena.Types.ListEngineVersionsOutput) => void): Request<Athena.Types.ListEngineVersionsOutput, AWSError>;
/**
* 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.
*/
listNamedQueries(params: Athena.Types.ListNamedQueriesInput, callback?: (err: AWSError, data: Athena.Types.ListNamedQueriesOutput) => void): Request<Athena.Types.ListNamedQueriesOutput, AWSError>;
/**
* 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.
*/
listNamedQueries(callback?: (err: AWSError, data: Athena.Types.ListNamedQueriesOutput) => void): Request<Athena.Types.ListNamedQueriesOutput, AWSError>;
/**
* Lists the prepared statements in the specified workgroup.
*/
listPreparedStatements(params: Athena.Types.ListPreparedStatementsInput, callback?: (err: AWSError, data: Athena.Types.ListPreparedStatementsOutput) => void): Request<Athena.Types.ListPreparedStatementsOutput, AWSError>;
/**
* Lists the prepared statements in the specified workgroup.
*/
listPreparedStatements(callback?: (err: AWSError, data: Athena.Types.ListPreparedStatementsOutput) => void): Request<Athena.Types.ListPreparedStatementsOutput, AWSError>;
/**
* 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.
*/
listQueryExecutions(params: Athena.Types.ListQueryExecutionsInput, callback?: (err: AWSError, data: Athena.Types.ListQueryExecutionsOutput) => void): Request<Athena.Types.ListQueryExecutionsOutput, AWSError>;
/**
* 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.
*/
listQueryExecutions(callback?: (err: AWSError, data: Athena.Types.ListQueryExecutionsOutput) => void): Request<Athena.Types.ListQueryExecutionsOutput, AWSError>;
/**
* Lists the metadata for the tables in the specified data catalog database.
*/
listTableMetadata(params: Athena.Types.ListTableMetadataInput, callback?: (err: AWSError, data: Athena.Types.ListTableMetadataOutput) => void): Request<Athena.Types.ListTableMetadataOutput, AWSError>;
/**
* Lists the metadata for the tables in the specified data catalog database.
*/
listTableMetadata(callback?: (err: AWSError, data: Athena.Types.ListTableMetadataOutput) => void): Request<Athena.Types.ListTableMetadataOutput, AWSError>;
/**
* Lists the tags associated with an Athena workgroup or data catalog resource.
*/
listTagsForResource(params: Athena.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: Athena.Types.ListTagsForResourceOutput) => void): Request<Athena.Types.ListTagsForResourceOutput, AWSError>;
/**
* Lists the tags associated with an Athena workgroup or data catalog resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Athena.Types.ListTagsForResourceOutput) => void): Request<Athena.Types.ListTagsForResourceOutput, AWSError>;
/**
* Lists available workgroups for the account.
*/
listWorkGroups(params: Athena.Types.ListWorkGroupsInput, callback?: (err: AWSError, data: Athena.Types.ListWorkGroupsOutput) => void): Request<Athena.Types.ListWorkGroupsOutput, AWSError>;
/**
* Lists available workgroups for the account.
*/
listWorkGroups(callback?: (err: AWSError, data: Athena.Types.ListWorkGroupsOutput) => void): Request<Athena.Types.ListWorkGroupsOutput, AWSError>;
/**
* 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.
*/
startQueryExecution(params: Athena.Types.StartQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.StartQueryExecutionOutput) => void): Request<Athena.Types.StartQueryExecutionOutput, AWSError>;
/**
* 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.
*/
startQueryExecution(callback?: (err: AWSError, data: Athena.Types.StartQueryExecutionOutput) => void): Request<Athena.Types.StartQueryExecutionOutput, AWSError>;
/**
* 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.
*/
stopQueryExecution(params: Athena.Types.StopQueryExecutionInput, callback?: (err: AWSError, data: Athena.Types.StopQueryExecutionOutput) => void): Request<Athena.Types.StopQueryExecutionOutput, AWSError>;
/**
* 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.
*/
stopQueryExecution(callback?: (err: AWSError, data: Athena.Types.StopQueryExecutionOutput) => void): Request<Athena.Types.StopQueryExecutionOutput, AWSError>;
/**
* 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.
*/
tagResource(params: Athena.Types.TagResourceInput, callback?: (err: AWSError, data: Athena.Types.TagResourceOutput) => void): Request<Athena.Types.TagResourceOutput, AWSError>;
/**
* 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.
*/
tagResource(callback?: (err: AWSError, data: Athena.Types.TagResourceOutput) => void): Request<Athena.Types.TagResourceOutput, AWSError>;
/**
* Removes one or more tags from a data catalog or workgroup resource.
*/
untagResource(params: Athena.Types.UntagResourceInput, callback?: (err: AWSError, data: Athena.Types.UntagResourceOutput) => void): Request<Athena.Types.UntagResourceOutput, AWSError>;
/**
* Removes one or more tags from a data catalog or workgroup resource.
*/
untagResource(callback?: (err: AWSError, data: Athena.Types.UntagResourceOutput) => void): Request<Athena.Types.UntagResourceOutput, AWSError>;
/**
* Updates the data catalog that has the specified name.
*/
updateDataCatalog(params: Athena.Types.UpdateDataCatalogInput, callback?: (err: AWSError, data: Athena.Types.UpdateDataCatalogOutput) => void): Request<Athena.Types.UpdateDataCatalogOutput, AWSError>;
/**
* Updates the data catalog that has the specified name.
*/
updateDataCatalog(callback?: (err: AWSError, data: Athena.Types.UpdateDataCatalogOutput) => void): Request<Athena.Types.UpdateDataCatalogOutput, AWSError>;
/**
* Updates a NamedQuery object. The database or workgroup cannot be updated.
*/
updateNamedQuery(params: Athena.Types.UpdateNamedQueryInput, callback?: (err: AWSError, data: Athena.Types.UpdateNamedQueryOutput) => void): Request<Athena.Types.UpdateNamedQueryOutput, AWSError>;
/**
* Updates a NamedQuery object. The database or workgroup cannot be updated.
*/
updateNamedQuery(callback?: (err: AWSError, data: Athena.Types.UpdateNamedQueryOutput) => void): Request<Athena.Types.UpdateNamedQueryOutput, AWSError>;
/**
* Updates a prepared statement.
*/
updatePreparedStatement(params: Athena.Types.UpdatePreparedStatementInput, callback?: (err: AWSError, data: Athena.Types.UpdatePreparedStatementOutput) => void): Request<Athena.Types.UpdatePreparedStatementOutput, AWSError>;
/**
* Updates a prepared statement.
*/
updatePreparedStatement(callback?: (err: AWSError, data: Athena.Types.UpdatePreparedStatementOutput) => void): Request<Athena.Types.UpdatePreparedStatementOutput, AWSError>;
/**
* Updates the workgroup with the specified name. The workgroup's name cannot be changed.
*/
updateWorkGroup(params: Athena.Types.UpdateWorkGroupInput, callback?: (err: AWSError, data: Athena.Types.UpdateWorkGroupOutput) => void): Request<Athena.Types.UpdateWorkGroupOutput, AWSError>;
/**
* Updates the workgroup with the specified name. The workgroup's name cannot be changed.
*/
updateWorkGroup(callback?: (err: AWSError, data: Athena.Types.UpdateWorkGroupOutput) => void): Request<Athena.Types.UpdateWorkGroupOutput, AWSError>;
}
declare namespace Athena {
export interface AclConfiguration {
/**
* The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.
*/
S3AclOption: S3AclOption;
}
export type Age = number;
export type AmazonResourceName = string;
export interface AthenaError {
/**
* An integer value that specifies the category of a query failure error. The following list shows the category for each integer value. 1 - System 2 - User 3 - Other
*/
ErrorCategory?: ErrorCategory;
/**
* An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.
*/
ErrorType?: ErrorType;
/**
* True if the query might succeed if resubmitted.
*/
Retryable?: Boolean;
/**
* Contains a short description of the error that occurred.
*/
ErrorMessage?: String;
}
export type AwsAccountId = string;
export interface BatchGetNamedQueryInput {
/**
* An array of query IDs.
*/
NamedQueryIds: NamedQueryIdList;
}
export interface BatchGetNamedQueryOutput {
/**
* Information about the named query IDs submitted.
*/
NamedQueries?: NamedQueryList;
/**
* Information about provided query IDs.
*/
UnprocessedNamedQueryIds?: UnprocessedNamedQueryIdList;
}
export interface BatchGetPreparedStatementInput {
/**
* A list of prepared statement names to return.
*/
PreparedStatementNames: PreparedStatementNameList;
/**
* The name of the workgroup to which the prepared statements belong.
*/
WorkGroup: WorkGroupName;
}
export interface BatchGetPreparedStatementOutput {
/**
* The list of prepared statements returned.
*/
PreparedStatements?: PreparedStatementDetailsList;
/**
* A list of one or more prepared statements that were requested but could not be returned.
*/
UnprocessedPreparedStatementNames?: UnprocessedPreparedStatementNameList;
}
export interface BatchGetQueryExecutionInput {
/**
* An array of query execution IDs.
*/
QueryExecutionIds: QueryExecutionIdList;
}
export interface BatchGetQueryExecutionOutput {
/**
* Information about a query execution.
*/
QueryExecutions?: QueryExecutionList;
/**
* Information about the query executions that failed to run.
*/
UnprocessedQueryExecutionIds?: UnprocessedQueryExecutionIdList;
}
export type Boolean = boolean;
export type BoxedBoolean = boolean;
export type BytesScannedCutoffValue = number;
export type CatalogNameString = string;
export interface Column {
/**
* The name of the column.
*/
Name: NameString;
/**
* The data type of the column.
*/
Type?: TypeString;
/**
* Optional information about the column.
*/
Comment?: CommentString;
}
export interface ColumnInfo {
/**
* The catalog to which the query results belong.
*/
CatalogName?: String;
/**
* The schema name (database name) to which the query results belong.
*/
SchemaName?: String;
/**
* The table name for the query results.
*/
TableName?: String;
/**
* The name of the column.
*/
Name: String;
/**
* A column label.
*/
Label?: String;
/**
* The data type of the column.
*/
Type: String;
/**
* For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.
*/
Precision?: Integer;
/**
* For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.
*/
Scale?: Integer;
/**
* Indicates the column's nullable status.
*/
Nullable?: ColumnNullable;
/**
* Indicates whether values in the column are case-sensitive.
*/
CaseSensitive?: Boolean;
}
export type ColumnInfoList = ColumnInfo[];
export type ColumnList = Column[];
export type ColumnNullable = "NOT_NULL"|"NULLABLE"|"UNKNOWN"|string;
export type CommentString = string;
export interface CreateDataCatalogInput {
/**
* The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
*/
Name: CatalogNameString;
/**
* The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.
*/
Type: DataCatalogType;
/**
* A description of the data catalog to be created.
*/
Description?: DescriptionString;
/**
* Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version. metadata-function=lambda_arn, sdk-version=version_number For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both. If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required. metadata-function=lambda_arn, record-function=lambda_arn If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function. function=lambda_arn The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs. catalog-id=catalog_id The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify. Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2. In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.
*/
Parameters?: ParametersMap;
/**
* A list of comma separated tags to add to the data catalog that is created.
*/
Tags?: TagList;
}
export interface CreateDataCatalogOutput {
}
export interface CreateNamedQueryInput {
/**
* The query name.
*/
Name: NameString;
/**
* The query description.
*/
Description?: DescriptionString;
/**
* The database to which the query belongs.
*/
Database: DatabaseString;
/**
* The contents of the query with all query statements.
*/
QueryString: QueryString;
/**
* A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned. This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
*/
ClientRequestToken?: IdempotencyToken;
/**
* The name of the workgroup in which the named query is being created.
*/
WorkGroup?: WorkGroupName;
}
export interface CreateNamedQueryOutput {
/**
* The unique ID of the query.
*/
NamedQueryId?: NamedQueryId;
}
export interface CreatePreparedStatementInput {
/**
* The name of the prepared statement.
*/
StatementName: StatementName;
/**
* The name of the workgroup to which the prepared statement belongs.
*/
WorkGroup: WorkGroupName;
/**
* The query string for the prepared statement.
*/
QueryStatement: QueryString;
/**
* The description of the prepared statement.
*/
Description?: DescriptionString;
}
export interface CreatePreparedStatementOutput {
}
export interface CreateWorkGroupInput {
/**
* The workgroup name.
*/
Name: WorkGroupName;
/**
* The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
*/
Configuration?: WorkGroupConfiguration;
/**
* The workgroup description.
*/
Description?: WorkGroupDescriptionString;
/**
* A list of comma separated tags to add to the workgroup that is created.
*/
Tags?: TagList;
}
export interface CreateWorkGroupOutput {
}
export interface DataCatalog {
/**
* The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
*/
Name: CatalogNameString;
/**
* An optional description of the data catalog.
*/
Description?: DescriptionString;
/**
* The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.
*/
Type: DataCatalogType;
/**
* Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type. For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version. metadata-function=lambda_arn, sdk-version=version_number For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both. If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required. metadata-function=lambda_arn, record-function=lambda_arn If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function. function=lambda_arn The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue catalog belongs. catalog-id=catalog_id The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify. Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.
*/
Parameters?: ParametersMap;
}
export interface DataCatalogSummary {
/**
* The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
*/
CatalogName?: CatalogNameString;
/**
* The data catalog type.
*/
Type?: DataCatalogType;
}
export type DataCatalogSummaryList = DataCatalogSummary[];
export type DataCatalogType = "LAMBDA"|"GLUE"|"HIVE"|string;
export interface Database {
/**
* The name of the database.
*/
Name: NameString;
/**
* An optional description of the database.
*/
Description?: DescriptionString;
/**
* A set of custom key/value pairs.
*/
Parameters?: ParametersMap;
}
export type DatabaseList = Database[];
export type DatabaseString = string;
export type _Date = Date;
export interface Datum {
/**
* The value of the datum.
*/
VarCharValue?: datumString;
}
export interface DeleteDataCatalogInput {
/**
* The name of the data catalog to delete.
*/
Name: CatalogNameString;
}
export interface DeleteDataCatalogOutput {
}
export interface DeleteNamedQueryInput {
/**
* The unique ID of the query to delete.
*/
NamedQueryId: NamedQueryId;
}
export interface DeleteNamedQueryOutput {
}
export interface DeletePreparedStatementInput {
/**
* The name of the prepared statement to delete.
*/
StatementName: StatementName;
/**
* The workgroup to which the statement to be deleted belongs.
*/
WorkGroup: WorkGroupName;
}
export interface DeletePreparedStatementOutput {
}
export interface DeleteWorkGroupInput {
/**
* The unique name of the workgroup to delete.
*/
WorkGroup: WorkGroupName;
/**
* The option to delete the workgroup and its contents even if the workgroup contains any named queries or query executions.
*/
RecursiveDeleteOption?: BoxedBoolean;
}
export interface DeleteWorkGroupOutput {
}
export type DescriptionString = string;
export interface EncryptionConfiguration {
/**
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used. If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
*/
EncryptionOption: EncryptionOption;
/**
* For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
*/
KmsKey?: String;
}
export type EncryptionOption = "SSE_S3"|"SSE_KMS"|"CSE_KMS"|string;
export interface EngineVersion {
/**
* The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including Auto. The default is Auto.
*/
SelectedEngineVersion?: NameString;
/**
* Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
*/
EffectiveEngineVersion?: NameString;
}
export type EngineVersionsList = EngineVersion[];
export type ErrorCategory = number;
export type ErrorCode = string;
export type ErrorMessage = string;
export type ErrorType = number;
export type ExecutionParameter = string;
export type ExecutionParameters = ExecutionParameter[];
export type ExpressionString = string;
export interface GetDataCatalogInput {
/**
* The name of the data catalog to return.
*/
Name: CatalogNameString;
}
export interface GetDataCatalogOutput {
/**
* The data catalog returned.
*/
DataCatalog?: DataCatalog;
}
export interface GetDatabaseInput {
/**
* The name of the data catalog that contains the database to return.
*/
CatalogName: CatalogNameString;
/**
* The name of the database to return.
*/
DatabaseName: NameString;
}
export interface GetDatabaseOutput {
/**
* The database returned.
*/
Database?: Database;
}
export interface GetNamedQueryInput {
/**
* The unique ID of the query. Use ListNamedQueries to get query IDs.
*/
NamedQueryId: NamedQueryId;
}
export interface GetNamedQueryOutput {
/**
* Information about the query.
*/
NamedQuery?: NamedQuery;
}
export interface GetPreparedStatementInput {
/**
* The name of the prepared statement to retrieve.
*/
StatementName: StatementName;
/**
* The workgroup to which the statement to be retrieved belongs.
*/
WorkGroup: WorkGroupName;
}
export interface GetPreparedStatementOutput {
/**
* The name of the prepared statement that was retrieved.
*/
PreparedStatement?: PreparedStatement;
}
export interface GetQueryExecutionInput {
/**
* The unique ID of the query execution.
*/
QueryExecutionId: QueryExecutionId;
}
export interface GetQueryExecutionOutput {
/**
* Information about the query execution.
*/
QueryExecution?: QueryExecution;
}
export interface GetQueryResultsInput {
/**
* The unique ID of the query execution.
*/
QueryExecutionId: QueryExecutionId;
/**
* A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
*/
NextToken?: Token;
/**
* The maximum number of results (rows) to return in this request.
*/
MaxResults?: MaxQueryResults;
}
export interface GetQueryResultsOutput {
/**
* The number of rows inserted with a CREATE TABLE AS SELECT statement.
*/
UpdateCount?: Long;
/**
* The results of the query execution.
*/
ResultSet?: ResultSet;
/**
* A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
*/
NextToken?: Token;
}
export interface GetQueryRuntimeStatisticsInput {
/**
* The unique ID of the query execution.
*/
QueryExecutionId: QueryExecutionId;
}
export interface GetQueryRuntimeStatisticsOutput {
/**
* Runtime statistics about the query execution.
*/
QueryRuntimeStatistics?: QueryRuntimeStatistics;
}
export interface GetTableMetadataInput {
/**
* The name of the data catalog that contains the database and table metadata to return.
*/
CatalogName: CatalogNameString;
/**
* The name of the database that contains the table metadata to return.
*/
DatabaseName: NameString;
/**
* The name of the table for which metadata is returned.
*/
TableName: NameString;
}
export interface GetTableMetadataOutput {
/**
* An object that contains table metadata.
*/
TableMetadata?: TableMetadata;
}
export interface GetWorkGroupInput {
/**
* The name of the workgroup.
*/
WorkGroup: WorkGroupName;
}
export interface GetWorkGroupOutput {
/**
* Information about the workgroup.
*/
WorkGroup?: WorkGroup;
}
export type IdempotencyToken = string;
export type Integer = number;
export type KeyString = string;
export interface ListDataCatalogsInput {
/**
* A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
*/
NextToken?: Token;
/**
* Specifies the maximum number of data catalogs to return.
*/
MaxResults?: MaxDataCatalogsCount;
}
export interface ListDataCatalogsOutput {
/**
* A summary list of data catalogs.
*/
DataCatalogsSummary?: DataCatalogSummaryList;
/**
* A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
*/
NextToken?: Token;
}
export interface ListDatabasesInput {
/**
* The name of the data catalog that contains the data