AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AclConfiguration

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. When Athena stores query results in Amazon S3, the canned ACL is set with the x-amz-acl request header. For more information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User Guide.

Class ApplicationDPUSizes

Contains the application runtime IDs and their supported DPU sizes.

Class AthenaError

Provides information about an Athena query error. The AthenaError feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. AthenaError includes an ErrorCategory field that specifies whether the cause of the failed query is due to system error, user error, or other error.

Class AthenaPaginatorFactory

Paginators for the Athena service

Class BatchGetNamedQueryRequest

Container for the parameters to the BatchGetNamedQuery operation. 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.

Class BatchGetNamedQueryResponse

This is the response object from the BatchGetNamedQuery operation.

Class BatchGetPreparedStatementRequest

Container for the parameters to the BatchGetPreparedStatement operation. 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.

Class BatchGetPreparedStatementResponse

This is the response object from the BatchGetPreparedStatement operation.

Class BatchGetQueryExecutionRequest

Container for the parameters to the BatchGetQueryExecution operation. 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.

Class BatchGetQueryExecutionResponse

This is the response object from the BatchGetQueryExecution operation.

Class CalculationConfiguration

Contains configuration information for the calculation.

Class CalculationResult

Contains information about an application-specific calculation result.

Class CalculationStatistics

Contains statistics for a notebook calculation.

Class CalculationStatus

Contains information about the status of a notebook calculation.

Class CalculationSummary

Summary information for a notebook calculation.

Class CancelCapacityReservationRequest

Container for the parameters to the CancelCapacityReservation operation. Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

Class CancelCapacityReservationResponse

This is the response object from the CancelCapacityReservation operation.

Class CapacityAllocation

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

Class CapacityAssignment

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

Class CapacityAssignmentConfiguration

Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.

Class CapacityReservation

A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.

Class Column

Contains metadata for a column in a table.

Class ColumnInfo

Information about the columns in a query execution result.

Class CreateCapacityReservationRequest

Container for the parameters to the CreateCapacityReservation operation. Creates a capacity reservation with the specified name and number of requested data processing units.

Class CreateCapacityReservationResponse

This is the response object from the CreateCapacityReservation operation.

Class CreateDataCatalogRequest

Container for the parameters to the CreateDataCatalog operation. 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.

Class CreateDataCatalogResponse

This is the response object from the CreateDataCatalog operation.

Class CreateNamedQueryRequest

Container for the parameters to the CreateNamedQuery operation. Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

Class CreateNamedQueryResponse

This is the response object from the CreateNamedQuery operation.

Class CreateNotebookRequest

Container for the parameters to the CreateNotebook operation. Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

Class CreateNotebookResponse

This is the response object from the CreateNotebook operation.

Class CreatePreparedStatementRequest

Container for the parameters to the CreatePreparedStatement operation. Creates a prepared statement for use with SQL queries in Athena.

Class CreatePreparedStatementResponse

This is the response object from the CreatePreparedStatement operation.

Class CreatePresignedNotebookUrlRequest

Container for the parameters to the CreatePresignedNotebookUrl operation. Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.

Class CreatePresignedNotebookUrlResponse

This is the response object from the CreatePresignedNotebookUrl operation.

Class CreateWorkGroupRequest

Container for the parameters to the CreateWorkGroup operation. Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

Class CreateWorkGroupResponse

This is the response object from the CreateWorkGroup operation.

Class CustomerContentEncryptionConfiguration

Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

Class Database

Contains metadata information for a database in a data catalog.

Class DataCatalog

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

In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

Class DataCatalogSummary

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

Class Datum

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

Class DeleteCapacityReservationRequest

Container for the parameters to the DeleteCapacityReservation operation. Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.

Class DeleteCapacityReservationResponse

This is the response object from the DeleteCapacityReservation operation.

Class DeleteDataCatalogRequest

Container for the parameters to the DeleteDataCatalog operation. Deletes a data catalog.

Class DeleteDataCatalogResponse

This is the response object from the DeleteDataCatalog operation.

Class DeleteNamedQueryRequest

Container for the parameters to the DeleteNamedQuery operation. Deletes the named query if you have access to the workgroup in which the query was saved.

Class DeleteNamedQueryResponse

This is the response object from the DeleteNamedQuery operation.

Class DeleteNotebookRequest

Container for the parameters to the DeleteNotebook operation. Deletes the specified notebook.

Class DeleteNotebookResponse

This is the response object from the DeleteNotebook operation.

Class DeletePreparedStatementRequest

Container for the parameters to the DeletePreparedStatement operation. Deletes the prepared statement with the specified name from the specified workgroup.

Class DeletePreparedStatementResponse

This is the response object from the DeletePreparedStatement operation.

Class DeleteWorkGroupRequest

Container for the parameters to the DeleteWorkGroup operation. Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

Class DeleteWorkGroupResponse

This is the response object from the DeleteWorkGroup operation.

Class EncryptionConfiguration

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.

Class EngineConfiguration

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

Class EngineVersion

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

Class ExecutorsSummary

Contains summary information about an executor.

Class ExportNotebookRequest

Container for the parameters to the ExportNotebook operation. Exports the specified notebook and its metadata.

Class ExportNotebookResponse

This is the response object from the ExportNotebook operation.

Class FilterDefinition

A string for searching notebook names.

Class GetCalculationExecutionCodeRequest

Container for the parameters to the GetCalculationExecutionCode operation. Retrieves the unencrypted code that was executed for the calculation.

Class GetCalculationExecutionCodeResponse

This is the response object from the GetCalculationExecutionCode operation.

Class GetCalculationExecutionRequest

Container for the parameters to the GetCalculationExecution operation. Describes a previously submitted calculation execution.

Class GetCalculationExecutionResponse

This is the response object from the GetCalculationExecution operation.

Class GetCalculationExecutionStatusRequest

Container for the parameters to the GetCalculationExecutionStatus operation. Gets the status of a current calculation.

Class GetCalculationExecutionStatusResponse

This is the response object from the GetCalculationExecutionStatus operation.

Class GetCapacityAssignmentConfigurationRequest

Container for the parameters to the GetCapacityAssignmentConfiguration operation. Gets the capacity assignment configuration for a capacity reservation, if one exists.

Class GetCapacityAssignmentConfigurationResponse

This is the response object from the GetCapacityAssignmentConfiguration operation.

Class GetCapacityReservationRequest

Container for the parameters to the GetCapacityReservation operation. Returns information about the capacity reservation with the specified name.

Class GetCapacityReservationResponse

This is the response object from the GetCapacityReservation operation.

Class GetDatabaseRequest

Container for the parameters to the GetDatabase operation. Returns a database object for the specified database and data catalog.

Class GetDatabaseResponse

This is the response object from the GetDatabase operation.

Class GetDataCatalogRequest

Container for the parameters to the GetDataCatalog operation. Returns the specified data catalog.

Class GetDataCatalogResponse

This is the response object from the GetDataCatalog operation.

Class GetNamedQueryRequest

Container for the parameters to the GetNamedQuery operation. Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

Class GetNamedQueryResponse

This is the response object from the GetNamedQuery operation.

Class GetNotebookMetadataRequest

Container for the parameters to the GetNotebookMetadata operation. Retrieves notebook metadata for the specified notebook ID.

Class GetNotebookMetadataResponse

This is the response object from the GetNotebookMetadata operation.

Class GetPreparedStatementRequest

Container for the parameters to the GetPreparedStatement operation. Retrieves the prepared statement with the specified name from the specified workgroup.

Class GetPreparedStatementResponse

This is the response object from the GetPreparedStatement operation.

Class GetQueryExecutionRequest

Container for the parameters to the GetQueryExecution operation. 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.

Class GetQueryExecutionResponse

This is the response object from the GetQueryExecution operation.

Class GetQueryResultsRequest

Container for the parameters to the GetQueryResults operation. Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files 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.

Class GetQueryResultsResponse

This is the response object from the GetQueryResults operation.

Class GetQueryRuntimeStatisticsRequest

Container for the parameters to the GetQueryRuntimeStatistics operation. 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. Statistics from the Timeline section of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.

Class GetQueryRuntimeStatisticsResponse

This is the response object from the GetQueryRuntimeStatistics operation.

Class GetSessionRequest

Container for the parameters to the GetSession operation. Gets the full details of a previously created session, including the session status and configuration.

Class GetSessionResponse

This is the response object from the GetSession operation.

Class GetSessionStatusRequest

Container for the parameters to the GetSessionStatus operation. Gets the current status of a session.

Class GetSessionStatusResponse

This is the response object from the GetSessionStatus operation.

Class GetTableMetadataRequest

Container for the parameters to the GetTableMetadata operation. Returns table metadata for the specified catalog, database, and table.

Class GetTableMetadataResponse

This is the response object from the GetTableMetadata operation.

Class GetWorkGroupRequest

Container for the parameters to the GetWorkGroup operation. Returns information about the workgroup with the specified name.

Class GetWorkGroupResponse

This is the response object from the GetWorkGroup operation.

Class IdentityCenterConfiguration

Specifies whether the workgroup is IAM Identity Center supported.

Class ImportNotebookRequest

Container for the parameters to the ImportNotebook operation. Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.

Class ImportNotebookResponse

This is the response object from the ImportNotebook operation.

Class InternalServerException

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

Class InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

Class ListApplicationDPUSizesRequest

Container for the parameters to the ListApplicationDPUSizes operation. Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).

Class ListApplicationDPUSizesResponse

This is the response object from the ListApplicationDPUSizes operation.

Class ListCalculationExecutionsRequest

Container for the parameters to the ListCalculationExecutions operation. Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

Class ListCalculationExecutionsResponse

This is the response object from the ListCalculationExecutions operation.

Class ListCapacityReservationsRequest

Container for the parameters to the ListCapacityReservations operation. Lists the capacity reservations for the current account.

Class ListCapacityReservationsResponse

This is the response object from the ListCapacityReservations operation.

Class ListDatabasesRequest

Container for the parameters to the ListDatabases operation. Lists the databases in the specified data catalog.

Class ListDatabasesResponse

This is the response object from the ListDatabases operation.

Class ListDataCatalogsRequest

Container for the parameters to the ListDataCatalogs operation. Lists the data catalogs in the current Amazon Web Services account.

In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

Class ListDataCatalogsResponse

This is the response object from the ListDataCatalogs operation.

Class ListEngineVersionsRequest

Container for the parameters to the ListEngineVersions operation. Returns a list of engine versions that are available to choose from, including the Auto option.

Class ListEngineVersionsResponse

This is the response object from the ListEngineVersions operation.

Class ListExecutorsRequest

Container for the parameters to the ListExecutors operation. Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

Class ListExecutorsResponse

This is the response object from the ListExecutors operation.

Class ListNamedQueriesRequest

Container for the parameters to the ListNamedQueries operation. 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.

Class ListNamedQueriesResponse

This is the response object from the ListNamedQueries operation.

Class ListNotebookMetadataRequest

Container for the parameters to the ListNotebookMetadata operation. Displays the notebook files for the specified workgroup in paginated format.

Class ListNotebookMetadataResponse

This is the response object from the ListNotebookMetadata operation.

Class ListNotebookSessionsRequest

Container for the parameters to the ListNotebookSessions operation. Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.

Class ListNotebookSessionsResponse

This is the response object from the ListNotebookSessions operation.

Class ListPreparedStatementsRequest

Container for the parameters to the ListPreparedStatements operation. Lists the prepared statements in the specified workgroup.

Class ListPreparedStatementsResponse

This is the response object from the ListPreparedStatements operation.

Class ListQueryExecutionsRequest

Container for the parameters to the ListQueryExecutions operation. Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. 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.

Class ListQueryExecutionsResponse

This is the response object from the ListQueryExecutions operation.

Class ListSessionsRequest

Container for the parameters to the ListSessions operation. Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Class ListSessionsResponse

This is the response object from the ListSessions operation.

Class ListTableMetadataRequest

Container for the parameters to the ListTableMetadata operation. Lists the metadata for the tables in the specified data catalog database.

Class ListTableMetadataResponse

This is the response object from the ListTableMetadata operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags associated with an Athena resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListWorkGroupsRequest

Container for the parameters to the ListWorkGroups operation. Lists available workgroups for the account.

Class ListWorkGroupsResponse

This is the response object from the ListWorkGroups operation.

Class MetadataException

An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.

Class NamedQuery

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

Class NotebookMetadata

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

Class NotebookSessionSummary

Contains the notebook session ID and notebook session creation time.

Class PreparedStatement

A prepared SQL statement for use with Athena.

Class PreparedStatementSummary

The name and last modified time of the prepared statement.

Class PutCapacityAssignmentConfigurationRequest

Container for the parameters to the PutCapacityAssignmentConfiguration operation. Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.

Class PutCapacityAssignmentConfigurationResponse

This is the response object from the PutCapacityAssignmentConfiguration operation.

Class QueryExecution

Information about a single instance of a query execution.

Class QueryExecutionContext

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

Class QueryExecutionStatistics

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.

Class QueryExecutionStatus

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

Class QueryResultsS3AccessGrantsConfiguration

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

Class QueryRuntimeStatistics

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

Class QueryRuntimeStatisticsRows

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.

Class QueryRuntimeStatisticsTimeline

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

Class QueryStage

Stage statistics such as input and output rows and bytes, execution time and stage state. This information also includes substages and the query stage plan.

Class QueryStagePlanNode

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

Class ResourceNotFoundException

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

Class ResultConfiguration

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.

Class ResultConfigurationUpdates

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

Class ResultReuseByAgeConfiguration

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

Class ResultReuseConfiguration

Specifies the query result reuse behavior for the query.

Class ResultReuseInformation

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

Class ResultSet

The metadata and rows that make up a query result set. The metadata describes the column structure and data types. To return a ResultSet object, use GetQueryResults.

Class ResultSetMetadata

The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata object, use GetQueryResults.

Class Row

The rows that make up a query result table.

Class SessionAlreadyExistsException

The specified session already exists.

Class SessionConfiguration

Contains session configuration information.

Class SessionStatistics

Contains statistics for a session.

Class SessionStatus

Contains information about the status of a session.

Class SessionSummary

Contains summary information about a session.

Class StartCalculationExecutionRequest

Container for the parameters to the StartCalculationExecution operation. Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.

Class StartCalculationExecutionResponse

This is the response object from the StartCalculationExecution operation.

Class StartQueryExecutionRequest

Container for the parameters to the StartQueryExecution operation. 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.

Class StartQueryExecutionResponse

This is the response object from the StartQueryExecution operation.

Class StartSessionRequest

Container for the parameters to the StartSession operation. Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

Class StartSessionResponse

This is the response object from the StartSession operation.

Class StopCalculationExecutionRequest

Container for the parameters to the StopCalculationExecution operation. Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect.

Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.

Class StopCalculationExecutionResponse

This is the response object from the StopCalculationExecution operation.

Class StopQueryExecutionRequest

Container for the parameters to the StopQueryExecution operation. Stops a query execution. Requires you to have access to the workgroup in which the query ran.

Class StopQueryExecutionResponse

This is the response object from the StopQueryExecution operation.

Class TableMetadata

Contains metadata for a table.

Class Tag

A label that you assign to a resource. Athena resources include workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena resources by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources 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.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. 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, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources 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.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TerminateSessionRequest

Container for the parameters to the TerminateSession operation. Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.

Class TerminateSessionResponse

This is the response object from the TerminateSession operation.

Class TooManyRequestsException

Indicates that the request was throttled.

Class UnprocessedNamedQueryId

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

Class UnprocessedPreparedStatementName

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

Class UnprocessedQueryExecutionId

Describes a query execution that failed to process.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes one or more tags from an Athena resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateCapacityReservationRequest

Container for the parameters to the UpdateCapacityReservation operation. Updates the number of requested data processing units for the capacity reservation with the specified name.

Class UpdateCapacityReservationResponse

This is the response object from the UpdateCapacityReservation operation.

Class UpdateDataCatalogRequest

Container for the parameters to the UpdateDataCatalog operation. Updates the data catalog that has the specified name.

Class UpdateDataCatalogResponse

This is the response object from the UpdateDataCatalog operation.

Class UpdateNamedQueryRequest

Container for the parameters to the UpdateNamedQuery operation. Updates a NamedQuery object. The database or workgroup cannot be updated.

Class UpdateNamedQueryResponse

This is the response object from the UpdateNamedQuery operation.

Class UpdateNotebookMetadataRequest

Container for the parameters to the UpdateNotebookMetadata operation. Updates the metadata for a notebook.

Class UpdateNotebookMetadataResponse

This is the response object from the UpdateNotebookMetadata operation.

Class UpdateNotebookRequest

Container for the parameters to the UpdateNotebook operation. Updates the contents of a Spark notebook.

Class UpdateNotebookResponse

This is the response object from the UpdateNotebook operation.

Class UpdatePreparedStatementRequest

Container for the parameters to the UpdatePreparedStatement operation. Updates a prepared statement.

Class UpdatePreparedStatementResponse

This is the response object from the UpdatePreparedStatement operation.

Class UpdateWorkGroupRequest

Container for the parameters to the UpdateWorkGroup operation. Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

Class UpdateWorkGroupResponse

This is the response object from the UpdateWorkGroup operation.

Class WorkGroup

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Class WorkGroupConfiguration

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 workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Class WorkGroupConfigurationUpdates

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.

Class WorkGroupSummary

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

Interfaces

NameDescription
Interface IAthenaPaginatorFactory

Paginators for the Athena service

Interface IGetQueryResultsPaginator

Paginator for the GetQueryResults operation

Interface IListApplicationDPUSizesPaginator

Paginator for the ListApplicationDPUSizes operation

Interface IListCalculationExecutionsPaginator

Paginator for the ListCalculationExecutions operation

Interface IListCapacityReservationsPaginator

Paginator for the ListCapacityReservations operation

Interface IListDatabasesPaginator

Paginator for the ListDatabases operation

Interface IListDataCatalogsPaginator

Paginator for the ListDataCatalogs operation

Interface IListEngineVersionsPaginator

Paginator for the ListEngineVersions operation

Interface IListExecutorsPaginator

Paginator for the ListExecutors operation

Interface IListNamedQueriesPaginator

Paginator for the ListNamedQueries operation

Interface IListPreparedStatementsPaginator

Paginator for the ListPreparedStatements operation

Interface IListQueryExecutionsPaginator

Paginator for the ListQueryExecutions operation

Interface IListSessionsPaginator

Paginator for the ListSessions operation

Interface IListTableMetadataPaginator

Paginator for the ListTableMetadata operation

Interface IListTagsForResourcePaginator

Paginator for the ListTagsForResource operation

Interface IListWorkGroupsPaginator

Paginator for the ListWorkGroups operation