Athena

public struct Athena

Client object for interacting with AWS Athena service.

Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide. If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Member variables

Initialization

  • Initialize the Athena client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

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

    Declaration

    Swift

    public func batchGetNamedQuery(_ input: BatchGetNamedQueryInput) -> EventLoopFuture<BatchGetNamedQueryOutput>

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

    Declaration

    Swift

    public func batchGetQueryExecution(_ input: BatchGetQueryExecutionInput) -> EventLoopFuture<BatchGetQueryExecutionOutput>

  • Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same AWS account.

    Declaration

    Swift

    public func createDataCatalog(_ input: CreateDataCatalogInput) -> EventLoopFuture<CreateDataCatalogOutput>

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

    Declaration

    Swift

    public func createNamedQuery(_ input: CreateNamedQueryInput) -> EventLoopFuture<CreateNamedQueryOutput>

  • Creates a workgroup with the specified name.

    Declaration

    Swift

    public func createWorkGroup(_ input: CreateWorkGroupInput) -> EventLoopFuture<CreateWorkGroupOutput>

  • Deletes a data catalog.

    Declaration

    Swift

    public func deleteDataCatalog(_ input: DeleteDataCatalogInput) -> EventLoopFuture<DeleteDataCatalogOutput>

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

    Declaration

    Swift

    public func deleteNamedQuery(_ input: DeleteNamedQueryInput) -> EventLoopFuture<DeleteNamedQueryOutput>

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

    Declaration

    Swift

    public func deleteWorkGroup(_ input: DeleteWorkGroupInput) -> EventLoopFuture<DeleteWorkGroupOutput>

  • Returns the specified data catalog.

    Declaration

    Swift

    public func getDataCatalog(_ input: GetDataCatalogInput) -> EventLoopFuture<GetDataCatalogOutput>

  • Returns a database object for the specfied database and data catalog.

    Declaration

    Swift

    public func getDatabase(_ input: GetDatabaseInput) -> EventLoopFuture<GetDatabaseOutput>

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

    Declaration

    Swift

    public func getNamedQuery(_ input: GetNamedQueryInput) -> EventLoopFuture<GetNamedQueryOutput>

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

    Declaration

    Swift

    public func getQueryExecution(_ input: GetQueryExecutionInput) -> EventLoopFuture<GetQueryExecutionOutput>

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

    Declaration

    Swift

    public func getQueryResults(_ input: GetQueryResultsInput) -> EventLoopFuture<GetQueryResultsOutput>

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

    Declaration

    Swift

    public func getTableMetadata(_ input: GetTableMetadataInput) -> EventLoopFuture<GetTableMetadataOutput>

  • Returns information about the workgroup with the specified name.

    Declaration

    Swift

    public func getWorkGroup(_ input: GetWorkGroupInput) -> EventLoopFuture<GetWorkGroupOutput>

  • Lists the data catalogs in the current AWS account.

    Declaration

    Swift

    public func listDataCatalogs(_ input: ListDataCatalogsInput) -> EventLoopFuture<ListDataCatalogsOutput>

  • Lists the databases in the specified data catalog.

    Declaration

    Swift

    public func listDatabases(_ input: ListDatabasesInput) -> EventLoopFuture<ListDatabasesOutput>

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

    Declaration

    Swift

    public func listNamedQueries(_ input: ListNamedQueriesInput) -> EventLoopFuture<ListNamedQueriesOutput>

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

    Declaration

    Swift

    public func listQueryExecutions(_ input: ListQueryExecutionsInput) -> EventLoopFuture<ListQueryExecutionsOutput>

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

    Declaration

    Swift

    public func listTableMetadata(_ input: ListTableMetadataInput) -> EventLoopFuture<ListTableMetadataOutput>

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

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceInput) -> EventLoopFuture<ListTagsForResourceOutput>

  • Lists available workgroups for the account.

    Declaration

    Swift

    public func listWorkGroups(_ input: ListWorkGroupsInput) -> EventLoopFuture<ListWorkGroupsOutput>

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

    Declaration

    Swift

    public func startQueryExecution(_ input: StartQueryExecutionInput) -> EventLoopFuture<StartQueryExecutionOutput>

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

    Declaration

    Swift

    public func stopQueryExecution(_ input: StopQueryExecutionInput) -> EventLoopFuture<StopQueryExecutionOutput>

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

    Declaration

    Swift

    public func tagResource(_ input: TagResourceInput) -> EventLoopFuture<TagResourceOutput>

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

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceInput) -> EventLoopFuture<UntagResourceOutput>

  • Updates the data catalog that has the specified name.

    Declaration

    Swift

    public func updateDataCatalog(_ input: UpdateDataCatalogInput) -> EventLoopFuture<UpdateDataCatalogOutput>

  • Updates the workgroup with the specified name. The workgroup’s name cannot be changed.

    Declaration

    Swift

    public func updateWorkGroup(_ input: UpdateWorkGroupInput) -> EventLoopFuture<UpdateWorkGroupOutput>

Paginators

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

    Declaration

    Swift

    public func getQueryResultsPaginator(_ input: GetQueryResultsInput, onPage: @escaping (GetQueryResultsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Lists the data catalogs in the current AWS account.

    Declaration

    Swift

    public func listDataCatalogsPaginator(_ input: ListDataCatalogsInput, onPage: @escaping (ListDataCatalogsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Lists the databases in the specified data catalog.

    Declaration

    Swift

    public func listDatabasesPaginator(_ input: ListDatabasesInput, onPage: @escaping (ListDatabasesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listNamedQueriesPaginator(_ input: ListNamedQueriesInput, onPage: @escaping (ListNamedQueriesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listQueryExecutionsPaginator(_ input: ListQueryExecutionsInput, onPage: @escaping (ListQueryExecutionsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listTableMetadataPaginator(_ input: ListTableMetadataInput, onPage: @escaping (ListTableMetadataOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listTagsForResourcePaginator(_ input: ListTagsForResourceInput, onPage: @escaping (ListTagsForResourceOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Lists available workgroups for the account.

    Declaration

    Swift

    public func listWorkGroupsPaginator(_ input: ListWorkGroupsInput, onPage: @escaping (ListWorkGroupsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum ColumnNullable : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum DataCatalogType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum EncryptionOption : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum QueryExecutionState : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum StatementType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum WorkGroupState : String, CustomStringConvertible, Codable