cloudworker-proxy
Version:
An api gateway for cloudflare workers
932 lines • 66.6 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 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 AWS 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 AWS 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 AWS 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 AWS 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 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 AWS 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 AWS 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 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 specfied 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 specfied 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>;
/**
* 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 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 AWS 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 AWS 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>;
/**
* 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 AWS 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 AWS 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>;
/**
* 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 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 type AmazonResourceName = 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 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 AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
*/
Name: CatalogNameString;
/**
* The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
*/
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 has no parameters.
*/
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 AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS 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 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 AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
*/
Name: CatalogNameString;
/**
* An optional description of the data catalog.
*/
Description?: DescriptionString;
/**
* The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
*/
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 has no parameters.
*/
Parameters?: ParametersMap;
}
export interface DataCatalogSummary {
/**
* The name of the data catalog.
*/
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 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.
*/
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 type ErrorCode = string;
export type ErrorMessage = string;
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 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 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 databases to return.
*/
CatalogName: CatalogNameString;
/**
* 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 results to return.
*/
MaxResults?: MaxDatabasesCount;
}
export interface ListDatabasesOutput {
/**
* A list of databases from a data catalog.
*/
DatabaseList?: DatabaseList;
/**
* 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 ListNamedQueriesInput {
/**
* 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 queries to return in this request.
*/
MaxResults?: MaxNamedQueriesCount;
/**
* The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.
*/
WorkGroup?: WorkGroupName;
}
export interface ListNamedQueriesOutput {
/**
* The list of unique query IDs.
*/
NamedQueryIds?: NamedQueryIdList;
/**
* 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 ListQueryExecutionsInput {
/**
* 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 query executions to return in this request.
*/
MaxResults?: MaxQueryExecutionsCount;
/**
* The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.
*/
WorkGroup?: WorkGroupName;
}
export interface ListQueryExecutionsOutput {
/**
* The unique IDs of each query execution as an array of strings.
*/
QueryExecutionIds?: QueryExecutionIdList;
/**
* A token to be used by the next request if this request is truncated.
*/
NextToken?: Token;
}
export interface ListTableMetadataInput {
/**
* The name of the data catalog for which table metadata should be returned.
*/
CatalogName: CatalogNameString;
/**
* The name of the database for which table metadata should be returned.
*/
DatabaseName: NameString;
/**
* A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.
*/
Expression?: ExpressionString;
/**
* 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 results to return.
*/
MaxResults?: MaxTableMetadataCount;
}
export interface ListTableMetadataOutput {
/**
* A list of table metadata.
*/
TableMetadataList?: TableMetadataList;
/**
* 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 ListTagsForResourceInput {
/**
* Lists the tags for the resource with the specified ARN.
*/
ResourceARN: AmazonResourceName;
/**
* The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the resource with the specified ARN.
*/
NextToken?: Token;
/**
* The maximum number of results to be returned per request that lists the tags for the resource.
*/
MaxResults?: MaxTagsCount;
}
export interface ListTagsForResourceOutput {
/**
* The list of tags associated with the specified resource.
*/
Tags?: TagList;
/**
* A token to be used by the next request if this request is truncated.
*/
NextToken?: Token;
}
export interface ListWorkGroupsInput {
/**
* 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 workgroups to return in this request.
*/
MaxResults?: MaxWorkGroupsCount;
}
export interface ListWorkGroupsOutput {
/**
* The list of workgroups, including their names, descriptions, creation times, and states.
*/
WorkGroups?: WorkGroupsList;
/**
* 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 type Long = number;
export type MaxDataCatalogsCount = number;
export type MaxDatabasesCount = number;
export type MaxNamedQueriesCount = number;
export type MaxQueryExecutionsCount = number;
export type MaxQueryResults = number;
export type MaxTableMetadataCount = number;
export type MaxTagsCount = number;
export type MaxWorkGroupsCount = number;
export type NameString = string;
export interface NamedQuery {
/**
* The query name.
*/
Name: NameString;
/**
* The query description.
*/
Description?: DescriptionString;
/**
* The database to which the query belongs.
*/
Database: DatabaseString;
/**
* The SQL query statements that comprise the query.
*/
QueryString: QueryString;
/**
* The unique identifier of the query.
*/
NamedQueryId?: NamedQueryId;
/**
* The name of the workgroup that contains the named query.
*/
WorkGroup?: WorkGroupName;
}
export type NamedQueryId = string;
export type NamedQueryIdList = NamedQueryId[];
export type NamedQueryList = NamedQuery[];
export type ParametersMap = {[key: string]: ParametersMapValue};
export type ParametersMapValue = string;
export interface QueryExecution {
/**
* The unique identifier for each query execution.
*/
QueryExecutionId?: QueryExecutionId;
/**
* The SQL query statements which the query execution ran.
*/
Query?: QueryString;
/**
* The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE <table>.
*/
StatementType?: StatementType;
/**
* The location in Amazon S3 where query results were 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 location for the query results and the encryption configuration that are specified for the workgroup.
*/
ResultConfiguration?: ResultConfiguration;
/**
* The database in which the query execution occurred.
*/
QueryExecutionContext?: QueryExecutionContext;
/**
* The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
*/
Status?: QueryExecutionStatus;
/**
* Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.
*/
Statistics?: QueryExecutionStatistics;
/**
* The name of the workgroup in which the query ran.
*/
WorkGroup?: WorkGroupName;
}
export interface QueryExecutionContext {
/**
* The name of the database used in the query execution.
*/
Database?: DatabaseString;
/**
* The name of the data catalog used in the query execution.
*/
Catalog?: CatalogNameString;
}
export type QueryExecutionId = string;
export type QueryExecutionIdList = QueryExecutionId[];
export type QueryExecutionList = QueryExecution[];
export type QueryExecutionState = "QUEUED"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|string;
export interface QueryExecutionStatistics {
/**
* The number of milliseconds that the query took to execute.
*/
EngineExecutionTimeInMillis?: Long;
/**
* The number of bytes in the data that was queried.
*/
DataScannedInBytes?: Long;
/**
* The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.
*/
DataManifestLocation?: String;
/**
* The number of milliseconds that Athena took to run the query.
*/
TotalExecutionTimeInMillis?: Long;
/**
* The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.
*/
QueryQueueTimeInMillis?: Long;
/**
* The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.
*/
QueryPlanningTimeInMillis?: Long;
/**
* The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
*/
ServiceProcessingTimeInMillis?: Long;
}
export interface QueryExecutionStatus {
/**
* The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution. Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from RUNNING or FAILED to QUEUED.
*/
State?: QueryExecutionState;
/**
* Further detail about the status of the query.
*/
StateChangeReason?: String;
/**
* The date and time that the query was submitted.
*/
SubmissionDateTime?: _Date;
/**
* The date and time that the query completed.
*/
CompletionDateTime?: _Date;
}
export type QueryString = string;
export interface ResultConfiguration {
/**
* The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If non