Package athenaiface provides an interface to enable mocking the Amazon Athena service client for testing your code.

AuthenticationType_Values returns all elements of the AuthenticationType enum.

CalculationExecutionState_Values returns all elements of the CalculationExecutionState enum.

CapacityAllocationStatus_Values returns all elements of the CapacityAllocationStatus enum.

CapacityReservationStatus_Values returns all elements of the CapacityReservationStatus enum.

ColumnNullable_Values returns all elements of the ColumnNullable enum.

DataCatalogType_Values returns all elements of the DataCatalogType enum.

EncryptionOption_Values returns all elements of the EncryptionOption enum.

ExecutorState_Values returns all elements of the ExecutorState enum.

ExecutorType_Values returns all elements of the ExecutorType enum.

New creates a new instance of the Athena client with a session.

NotebookType_Values returns all elements of the NotebookType enum.

QueryExecutionState_Values returns all elements of the QueryExecutionState enum.

S3AclOption_Values returns all elements of the S3AclOption enum.

SessionState_Values returns all elements of the SessionState enum.

StatementType_Values returns all elements of the StatementType enum.

ThrottleReason_Values returns all elements of the ThrottleReason enum.

WorkGroupState_Values returns all elements of the WorkGroupState enum.

AuthenticationTypeDirectoryIdentity is a AuthenticationType enum value.

CalculationExecutionStateCanceled is a CalculationExecutionState enum value.

CalculationExecutionStateCanceling is a CalculationExecutionState enum value.

CalculationExecutionStateCompleted is a CalculationExecutionState enum value.

CalculationExecutionStateCreated is a CalculationExecutionState enum value.

CalculationExecutionStateCreating is a CalculationExecutionState enum value.

CalculationExecutionStateFailed is a CalculationExecutionState enum value.

CalculationExecutionStateQueued is a CalculationExecutionState enum value.

CalculationExecutionStateRunning is a CalculationExecutionState enum value.

CapacityAllocationStatusFailed is a CapacityAllocationStatus enum value.

CapacityAllocationStatusPending is a CapacityAllocationStatus enum value.

CapacityAllocationStatusSucceeded is a CapacityAllocationStatus enum value.

CapacityReservationStatusActive is a CapacityReservationStatus enum value.

CapacityReservationStatusCancelled is a CapacityReservationStatus enum value.

CapacityReservationStatusCancelling is a CapacityReservationStatus enum value.

CapacityReservationStatusFailed is a CapacityReservationStatus enum value.

CapacityReservationStatusPending is a CapacityReservationStatus enum value.

CapacityReservationStatusUpdatePending is a CapacityReservationStatus enum value.

ColumnNullableNotNull is a ColumnNullable enum value.

ColumnNullableNullable is a ColumnNullable enum value.

ColumnNullableUnknown is a ColumnNullable enum value.

DataCatalogTypeGlue is a DataCatalogType enum value.

DataCatalogTypeHive is a DataCatalogType enum value.

DataCatalogTypeLambda is a DataCatalogType enum value.

EncryptionOptionCseKms is a EncryptionOption enum value.

EncryptionOptionSseKms is a EncryptionOption enum value.

EncryptionOptionSseS3 is a EncryptionOption enum value.

ID to lookup a service endpoint with.

ErrCodeInternalServerException for service response error code "InternalServerException".

ErrCodeInvalidRequestException for service response error code "InvalidRequestException".

ErrCodeMetadataException for service response error code "MetadataException".

ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".

ErrCodeSessionAlreadyExistsException for service response error code "SessionAlreadyExistsException".

ErrCodeTooManyRequestsException for service response error code "TooManyRequestsException".

ExecutorStateCreated is a ExecutorState enum value.

ExecutorStateCreating is a ExecutorState enum value.

ExecutorStateFailed is a ExecutorState enum value.

ExecutorStateRegistered is a ExecutorState enum value.

ExecutorStateTerminated is a ExecutorState enum value.

ExecutorStateTerminating is a ExecutorState enum value.

ExecutorTypeCoordinator is a ExecutorType enum value.

ExecutorTypeGateway is a ExecutorType enum value.

ExecutorTypeWorker is a ExecutorType enum value.

NotebookTypeIpynb is a NotebookType enum value.

QueryExecutionStateCancelled is a QueryExecutionState enum value.

QueryExecutionStateFailed is a QueryExecutionState enum value.

QueryExecutionStateQueued is a QueryExecutionState enum value.

QueryExecutionStateRunning is a QueryExecutionState enum value.

QueryExecutionStateSucceeded is a QueryExecutionState enum value.

S3AclOptionBucketOwnerFullControl is a S3AclOption enum value.

ServiceID is a unique identifier of a specific service.

Name of service.

SessionStateBusy is a SessionState enum value.

SessionStateCreated is a SessionState enum value.

SessionStateCreating is a SessionState enum value.

SessionStateDegraded is a SessionState enum value.

SessionStateFailed is a SessionState enum value.

SessionStateIdle is a SessionState enum value.

SessionStateTerminated is a SessionState enum value.

SessionStateTerminating is a SessionState enum value.

StatementTypeDdl is a StatementType enum value.

StatementTypeDml is a StatementType enum value.

StatementTypeUtility is a StatementType enum value.

ThrottleReasonConcurrentQueryLimitExceeded is a ThrottleReason enum value.

WorkGroupStateDisabled is a WorkGroupState enum value.

WorkGroupStateEnabled is a WorkGroupState enum value.

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.

Contains the application runtime IDs and their supported DPU sizes.

Athena provides the API operation methods for making requests to Amazon Athena.

Provides information about an Athena query error.

Contains an array of named query IDs.

Contains an array of query execution IDs.

Contains configuration information for the calculation.

Contains information about an application-specific calculation result.

Contains statistics for a notebook calculation.

Contains information about the status of a notebook calculation.

Summary information for a notebook calculation.

Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.

A mapping between one or more workgroups and a capacity reservation.

Assigns Athena workgroups (and hence their queries) to capacity reservations.

A reservation for a specified number of data processing units (DPUs).

Contains metadata for a column in a table.

Information about the columns in a query execution result.

Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena.

Contains metadata information for a database in a data catalog.

Contains information about a data catalog in an Amazon Web Services account.

The summary information for the data catalog, which includes its name and type.

A piece of data (a field in the table).

If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.

Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.

The Athena engine version for running queries, or the PySpark engine version for running sessions.

Contains summary information about an executor.

A string for searching notebook names.

Specifies whether the workgroup is IAM Identity Center supported.

Indicates a platform issue, which may be due to a transient condition or outage.

Indicates that something is wrong with the input to the request.

An exception that Athena received when it called a custom metastore.

A query, where QueryString contains the SQL statements that make up the query.

Contains metadata for notebook, including the notebook name, ID, workgroup, and time created.

Contains the notebook session ID and notebook session creation time.

A prepared SQL statement for use with Athena.

The name and last modified time of the prepared statement.

Information about a single instance of a query execution.

The database and data catalog context in which the query execution occurs.

The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

Specifies whether Amazon S3 access grants are enabled for query results.

The query execution timeline, statistics on input and output rows and bytes, and the different query stages that form the query execution plan.

Statistics such as input rows and bytes read by the query, rows and bytes output by the query, and the number of rows written by the query.

Timeline statistics such as query queue time, planning time, execution time, service processing time, and total execution time.

Stage statistics such as input and output rows and bytes, execution time and stage state.

Stage plan information such as name, identifier, sub plans, and remote sources.

A resource, such as a workgroup, was not found.

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.

The information about the updates in the query results, such as output location and encryption configuration for the query results.

Specifies whether previous query results are reused, and if so, their maximum age.

Specifies the query result reuse behavior for the query.

Contains information about whether the result of a previous query was reused.

The metadata and rows that make up a query result set.

The metadata that describes the column structure and data types of a table of query results.

The rows that make up a query result table.

The specified session already exists.

Contains session configuration information.

Contains statistics for a session.

Contains information about the status of a session.

Contains summary information about a session.

Contains metadata for a table.

A label that you assign to a resource.

Indicates that the request was throttled.

Information about a named query ID that could not be processed.

The name of a prepared statement that could not be returned.

Describes a query execution that failed to process.

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration.

The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query and calculation results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup.

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.