Amazonka.Athena.Lens

Operations

BatchGetNamedQuery

batchGetNamedQuery_namedQueryIds :: Lens' BatchGetNamedQuery (NonEmpty Text)

An array of query IDs.

batchGetNamedQueryResponse_namedQueries :: Lens' BatchGetNamedQueryResponse (Maybe [NamedQuery])

Information about the named query IDs submitted.

batchGetNamedQueryResponse_unprocessedNamedQueryIds :: Lens' BatchGetNamedQueryResponse (Maybe [UnprocessedNamedQueryId])

Information about provided query IDs.

batchGetNamedQueryResponse_httpStatus :: Lens' BatchGetNamedQueryResponse Int

The response's http status code.

BatchGetPreparedStatement

batchGetPreparedStatement_preparedStatementNames :: Lens' BatchGetPreparedStatement [Text]

A list of prepared statement names to return.

batchGetPreparedStatement_workGroup :: Lens' BatchGetPreparedStatement Text

The name of the workgroup to which the prepared statements belong.

batchGetPreparedStatementResponse_preparedStatements :: Lens' BatchGetPreparedStatementResponse (Maybe [PreparedStatement])

The list of prepared statements returned.

batchGetPreparedStatementResponse_unprocessedPreparedStatementNames :: Lens' BatchGetPreparedStatementResponse (Maybe [UnprocessedPreparedStatementName])

A list of one or more prepared statements that were requested but could not be returned.

batchGetPreparedStatementResponse_httpStatus :: Lens' BatchGetPreparedStatementResponse Int

The response's http status code.

BatchGetQueryExecution

batchGetQueryExecution_queryExecutionIds :: Lens' BatchGetQueryExecution (NonEmpty Text)

An array of query execution IDs.

batchGetQueryExecutionResponse_queryExecutions :: Lens' BatchGetQueryExecutionResponse (Maybe [QueryExecution])

Information about a query execution.

batchGetQueryExecutionResponse_unprocessedQueryExecutionIds :: Lens' BatchGetQueryExecutionResponse (Maybe [UnprocessedQueryExecutionId])

Information about the query executions that failed to run.

batchGetQueryExecutionResponse_httpStatus :: Lens' BatchGetQueryExecutionResponse Int

The response's http status code.

CreateDataCatalog

createDataCatalog_description :: Lens' CreateDataCatalog (Maybe Text)

A description of the data catalog to be created.

createDataCatalog_parameters :: Lens' CreateDataCatalog (Maybe (HashMap Text Text))

Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.

• For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.

  metadata-function=lambda_arn, sdk-version=version_number

• For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

  • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

    metadata-function=lambda_arn, record-function=lambda_arn

  • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

    function=lambda_arn

• The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.

  catalog-id=catalog_id

  • The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.
  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.
  • In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALID_INPUT error.

createDataCatalog_tags :: Lens' CreateDataCatalog (Maybe [Tag])

A list of comma separated tags to add to the data catalog that is created.

createDataCatalog_name :: Lens' CreateDataCatalog Text

The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

createDataCatalog_type :: Lens' CreateDataCatalog DataCatalogType

The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

createDataCatalogResponse_httpStatus :: Lens' CreateDataCatalogResponse Int

The response's http status code.

CreateNamedQuery

createNamedQuery_clientRequestToken :: Lens' CreateNamedQuery (Maybe Text)

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

createNamedQuery_description :: Lens' CreateNamedQuery (Maybe Text)

The query description.

createNamedQuery_workGroup :: Lens' CreateNamedQuery (Maybe Text)

The name of the workgroup in which the named query is being created.

createNamedQuery_name :: Lens' CreateNamedQuery Text

The query name.

createNamedQuery_database :: Lens' CreateNamedQuery Text

The database to which the query belongs.

createNamedQuery_queryString :: Lens' CreateNamedQuery Text

The contents of the query with all query statements.

createNamedQueryResponse_namedQueryId :: Lens' CreateNamedQueryResponse (Maybe Text)

The unique ID of the query.

createNamedQueryResponse_httpStatus :: Lens' CreateNamedQueryResponse Int

The response's http status code.

CreateNotebook

createNotebook_clientRequestToken :: Lens' CreateNotebook (Maybe Text)

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

createNotebook_workGroup :: Lens' CreateNotebook Text

The name of the Spark enabled workgroup in which the notebook will be created.

createNotebook_name :: Lens' CreateNotebook Text

The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.

createNotebookResponse_notebookId :: Lens' CreateNotebookResponse (Maybe Text)

A unique identifier for the notebook.

createNotebookResponse_httpStatus :: Lens' CreateNotebookResponse Int

The response's http status code.

CreatePreparedStatement

createPreparedStatement_description :: Lens' CreatePreparedStatement (Maybe Text)

The description of the prepared statement.

createPreparedStatement_statementName :: Lens' CreatePreparedStatement Text

The name of the prepared statement.

createPreparedStatement_workGroup :: Lens' CreatePreparedStatement Text

The name of the workgroup to which the prepared statement belongs.

createPreparedStatement_queryStatement :: Lens' CreatePreparedStatement Text

The query string for the prepared statement.

createPreparedStatementResponse_httpStatus :: Lens' CreatePreparedStatementResponse Int

The response's http status code.

CreatePresignedNotebookUrl

createPresignedNotebookUrl_sessionId :: Lens' CreatePresignedNotebookUrl Text

The session ID.

createPresignedNotebookUrlResponse_httpStatus :: Lens' CreatePresignedNotebookUrlResponse Int

The response's http status code.

createPresignedNotebookUrlResponse_notebookUrl :: Lens' CreatePresignedNotebookUrlResponse Text

The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook.

createPresignedNotebookUrlResponse_authToken :: Lens' CreatePresignedNotebookUrlResponse Text

The authentication token for the notebook.

createPresignedNotebookUrlResponse_authTokenExpirationTime :: Lens' CreatePresignedNotebookUrlResponse Integer

The UTC epoch time when the authentication token expires.

CreateWorkGroup

createWorkGroup_configuration :: Lens' CreateWorkGroup (Maybe WorkGroupConfiguration)

Contains configuration information for creating an Athena SQL 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.

createWorkGroup_description :: Lens' CreateWorkGroup (Maybe Text)

The workgroup description.

createWorkGroup_tags :: Lens' CreateWorkGroup (Maybe [Tag])

A list of comma separated tags to add to the workgroup that is created.

createWorkGroup_name :: Lens' CreateWorkGroup Text

The workgroup name.

createWorkGroupResponse_httpStatus :: Lens' CreateWorkGroupResponse Int

The response's http status code.

DeleteDataCatalog

deleteDataCatalog_name :: Lens' DeleteDataCatalog Text

The name of the data catalog to delete.

deleteDataCatalogResponse_httpStatus :: Lens' DeleteDataCatalogResponse Int

The response's http status code.

DeleteNamedQuery

deleteNamedQuery_namedQueryId :: Lens' DeleteNamedQuery Text

The unique ID of the query to delete.

deleteNamedQueryResponse_httpStatus :: Lens' DeleteNamedQueryResponse Int

The response's http status code.

DeleteNotebook

deleteNotebook_notebookId :: Lens' DeleteNotebook Text

The ID of the notebook to delete.

deleteNotebookResponse_httpStatus :: Lens' DeleteNotebookResponse Int

The response's http status code.

DeletePreparedStatement

deletePreparedStatement_statementName :: Lens' DeletePreparedStatement Text

The name of the prepared statement to delete.

deletePreparedStatement_workGroup :: Lens' DeletePreparedStatement Text

The workgroup to which the statement to be deleted belongs.

deletePreparedStatementResponse_httpStatus :: Lens' DeletePreparedStatementResponse Int

The response's http status code.

DeleteWorkGroup

deleteWorkGroup_recursiveDeleteOption :: Lens' DeleteWorkGroup (Maybe Bool)

The option to delete the workgroup and its contents even if the workgroup contains any named queries or query executions.

deleteWorkGroup_workGroup :: Lens' DeleteWorkGroup Text

The unique name of the workgroup to delete.

deleteWorkGroupResponse_httpStatus :: Lens' DeleteWorkGroupResponse Int

The response's http status code.

ExportNotebook

exportNotebook_notebookId :: Lens' ExportNotebook Text

The ID of the notebook to export.

exportNotebookResponse_notebookMetadata :: Lens' ExportNotebookResponse (Maybe NotebookMetadata)

The notebook metadata, including notebook ID, notebook name, and workgroup name.

exportNotebookResponse_payload :: Lens' ExportNotebookResponse (Maybe Text)

The content of the exported notebook.

exportNotebookResponse_httpStatus :: Lens' ExportNotebookResponse Int

The response's http status code.

GetCalculationExecution

getCalculationExecution_calculationExecutionId :: Lens' GetCalculationExecution Text

The calculation execution UUID.

getCalculationExecutionResponse_calculationExecutionId :: Lens' GetCalculationExecutionResponse (Maybe Text)

The calculation execution UUID.

getCalculationExecutionResponse_description :: Lens' GetCalculationExecutionResponse (Maybe Text)

The description of the calculation execution.

getCalculationExecutionResponse_result :: Lens' GetCalculationExecutionResponse (Maybe CalculationResult)

Contains result information. This field is populated only if the calculation is completed.

getCalculationExecutionResponse_sessionId :: Lens' GetCalculationExecutionResponse (Maybe Text)

The session ID that the calculation ran in.

getCalculationExecutionResponse_statistics :: Lens' GetCalculationExecutionResponse (Maybe CalculationStatistics)

Contains information about the data processing unit (DPU) execution time and progress. This field is populated only when statistics are available.

getCalculationExecutionResponse_status :: Lens' GetCalculationExecutionResponse (Maybe CalculationStatus)

Contains information about the status of the calculation.

getCalculationExecutionResponse_workingDirectory :: Lens' GetCalculationExecutionResponse (Maybe Text)

The Amazon S3 location in which calculation results are stored.

getCalculationExecutionResponse_httpStatus :: Lens' GetCalculationExecutionResponse Int

The response's http status code.

GetCalculationExecutionCode

getCalculationExecutionCode_calculationExecutionId :: Lens' GetCalculationExecutionCode Text

The calculation execution UUID.

getCalculationExecutionCodeResponse_codeBlock :: Lens' GetCalculationExecutionCodeResponse (Maybe Text)

A pre-signed URL to the code that executed the calculation.

getCalculationExecutionCodeResponse_httpStatus :: Lens' GetCalculationExecutionCodeResponse Int

The response's http status code.

GetCalculationExecutionStatus

getCalculationExecutionStatus_calculationExecutionId :: Lens' GetCalculationExecutionStatus Text

The calculation execution UUID.

getCalculationExecutionStatusResponse_statistics :: Lens' GetCalculationExecutionStatusResponse (Maybe CalculationStatistics)

Contains information about the DPU execution time and progress.

getCalculationExecutionStatusResponse_status :: Lens' GetCalculationExecutionStatusResponse (Maybe CalculationStatus)

Contains information about the calculation execution status.

getCalculationExecutionStatusResponse_httpStatus :: Lens' GetCalculationExecutionStatusResponse Int

The response's http status code.

GetDataCatalog

getDataCatalog_name :: Lens' GetDataCatalog Text

The name of the data catalog to return.

getDataCatalogResponse_dataCatalog :: Lens' GetDataCatalogResponse (Maybe DataCatalog)

The data catalog returned.

getDataCatalogResponse_httpStatus :: Lens' GetDataCatalogResponse Int

The response's http status code.

GetDatabase

getDatabase_catalogName :: Lens' GetDatabase Text

The name of the data catalog that contains the database to return.

getDatabase_databaseName :: Lens' GetDatabase Text

The name of the database to return.

getDatabaseResponse_database :: Lens' GetDatabaseResponse (Maybe Database)

The database returned.

getDatabaseResponse_httpStatus :: Lens' GetDatabaseResponse Int

The response's http status code.

GetNamedQuery

getNamedQuery_namedQueryId :: Lens' GetNamedQuery Text

The unique ID of the query. Use ListNamedQueries to get query IDs.

getNamedQueryResponse_namedQuery :: Lens' GetNamedQueryResponse (Maybe NamedQuery)

Information about the query.

getNamedQueryResponse_httpStatus :: Lens' GetNamedQueryResponse Int

The response's http status code.

GetNotebookMetadata

getNotebookMetadata_notebookId :: Lens' GetNotebookMetadata Text

The ID of the notebook whose metadata is to be retrieved.

getNotebookMetadataResponse_notebookMetadata :: Lens' GetNotebookMetadataResponse (Maybe NotebookMetadata)

The metadata that is returned for the specified notebook ID.

getNotebookMetadataResponse_httpStatus :: Lens' GetNotebookMetadataResponse Int

The response's http status code.

GetPreparedStatement

getPreparedStatement_statementName :: Lens' GetPreparedStatement Text

The name of the prepared statement to retrieve.

getPreparedStatement_workGroup :: Lens' GetPreparedStatement Text

The workgroup to which the statement to be retrieved belongs.

getPreparedStatementResponse_preparedStatement :: Lens' GetPreparedStatementResponse (Maybe PreparedStatement)

The name of the prepared statement that was retrieved.

getPreparedStatementResponse_httpStatus :: Lens' GetPreparedStatementResponse Int

The response's http status code.

GetQueryExecution

getQueryExecution_queryExecutionId :: Lens' GetQueryExecution Text

The unique ID of the query execution.

getQueryExecutionResponse_queryExecution :: Lens' GetQueryExecutionResponse (Maybe QueryExecution)

Information about the query execution.

getQueryExecutionResponse_httpStatus :: Lens' GetQueryExecutionResponse Int

The response's http status code.

GetQueryResults

getQueryResults_maxResults :: Lens' GetQueryResults (Maybe Natural)

The maximum number of results (rows) to return in this request.

getQueryResults_nextToken :: Lens' GetQueryResults (Maybe Text)

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.

getQueryResults_queryExecutionId :: Lens' GetQueryResults Text

The unique ID of the query execution.

getQueryResultsResponse_nextToken :: Lens' GetQueryResultsResponse (Maybe Text)

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.

getQueryResultsResponse_resultSet :: Lens' GetQueryResultsResponse (Maybe ResultSet)

The results of the query execution.

getQueryResultsResponse_updateCount :: Lens' GetQueryResultsResponse (Maybe Integer)

The number of rows inserted with a CREATE TABLE AS SELECT statement.

getQueryResultsResponse_httpStatus :: Lens' GetQueryResultsResponse Int

The response's http status code.

GetQueryRuntimeStatistics

getQueryRuntimeStatistics_queryExecutionId :: Lens' GetQueryRuntimeStatistics Text

The unique ID of the query execution.

getQueryRuntimeStatisticsResponse_queryRuntimeStatistics :: Lens' GetQueryRuntimeStatisticsResponse (Maybe QueryRuntimeStatistics)

Runtime statistics about the query execution.

getQueryRuntimeStatisticsResponse_httpStatus :: Lens' GetQueryRuntimeStatisticsResponse Int

The response's http status code.

GetSession

getSession_sessionId :: Lens' GetSession Text

The session ID.

getSessionResponse_description :: Lens' GetSessionResponse (Maybe Text)

The session description.

getSessionResponse_engineConfiguration :: Lens' GetSessionResponse (Maybe EngineConfiguration)

Contains engine configuration information like DPU usage.

getSessionResponse_engineVersion :: Lens' GetSessionResponse (Maybe Text)

The engine version used by the session (for example, PySpark engine version 3). You can get a list of engine versions by calling ListEngineVersions.

getSessionResponse_notebookVersion :: Lens' GetSessionResponse (Maybe Text)

The notebook version.

getSessionResponse_sessionConfiguration :: Lens' GetSessionResponse (Maybe SessionConfiguration)

Contains the workgroup configuration information used by the session.

getSessionResponse_sessionId :: Lens' GetSessionResponse (Maybe Text)

The session ID.

getSessionResponse_statistics :: Lens' GetSessionResponse (Maybe SessionStatistics)

Contains the DPU execution time.

getSessionResponse_status :: Lens' GetSessionResponse (Maybe SessionStatus)

Contains information about the status of the session.

getSessionResponse_workGroup :: Lens' GetSessionResponse (Maybe Text)

The workgroup to which the session belongs.

getSessionResponse_httpStatus :: Lens' GetSessionResponse Int

The response's http status code.

GetSessionStatus

getSessionStatus_sessionId :: Lens' GetSessionStatus Text

The session ID.

getSessionStatusResponse_sessionId :: Lens' GetSessionStatusResponse (Maybe Text)

The session ID.

getSessionStatusResponse_status :: Lens' GetSessionStatusResponse (Maybe SessionStatus)

Contains information about the status of the session.

getSessionStatusResponse_httpStatus :: Lens' GetSessionStatusResponse Int

The response's http status code.

GetTableMetadata

getTableMetadata_catalogName :: Lens' GetTableMetadata Text

The name of the data catalog that contains the database and table metadata to return.

getTableMetadata_databaseName :: Lens' GetTableMetadata Text

The name of the database that contains the table metadata to return.

getTableMetadata_tableName :: Lens' GetTableMetadata Text

The name of the table for which metadata is returned.

getTableMetadataResponse_tableMetadata :: Lens' GetTableMetadataResponse (Maybe TableMetadata)

An object that contains table metadata.

getTableMetadataResponse_httpStatus :: Lens' GetTableMetadataResponse Int

The response's http status code.

GetWorkGroup

getWorkGroup_workGroup :: Lens' GetWorkGroup Text

The name of the workgroup.

getWorkGroupResponse_workGroup :: Lens' GetWorkGroupResponse (Maybe WorkGroup)

Information about the workgroup.

getWorkGroupResponse_httpStatus :: Lens' GetWorkGroupResponse Int

The response's http status code.

ImportNotebook

importNotebook_clientRequestToken :: Lens' ImportNotebook (Maybe Text)

A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

importNotebook_workGroup :: Lens' ImportNotebook Text

The name of the Spark enabled workgroup to import the notebook to.

importNotebook_name :: Lens' ImportNotebook Text

The name of the notebook to import.

importNotebook_payload :: Lens' ImportNotebook Text

The notebook content to be imported.

importNotebook_type :: Lens' ImportNotebook NotebookType

The notebook content type. Currently, the only valid type is IPYNB.

importNotebookResponse_notebookId :: Lens' ImportNotebookResponse (Maybe Text)

The ID of the notebook to import.

importNotebookResponse_httpStatus :: Lens' ImportNotebookResponse Int

The response's http status code.

ListApplicationDPUSizes

listApplicationDPUSizes_maxResults :: Lens' ListApplicationDPUSizes (Maybe Natural)

Specifies the maximum number of results to return.

listApplicationDPUSizes_nextToken :: Lens' ListApplicationDPUSizes (Maybe Text)

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

listApplicationDPUSizesResponse_applicationDPUSizes :: Lens' ListApplicationDPUSizesResponse (Maybe [ApplicationDPUSizes])

A list of the supported DPU sizes that the application runtime supports.

listApplicationDPUSizesResponse_nextToken :: Lens' ListApplicationDPUSizesResponse (Maybe Text)

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.

listApplicationDPUSizesResponse_httpStatus :: Lens' ListApplicationDPUSizesResponse Int

The response's http status code.

ListCalculationExecutions

listCalculationExecutions_maxResults :: Lens' ListCalculationExecutions (Maybe Natural)

The maximum number of calculation executions to return.

listCalculationExecutions_nextToken :: Lens' ListCalculationExecutions (Maybe Text)

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.

listCalculationExecutions_stateFilter :: Lens' ListCalculationExecutions (Maybe CalculationExecutionState)

A filter for a specific calculation execution state. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

listCalculationExecutions_sessionId :: Lens' ListCalculationExecutions Text

The session ID.

listCalculationExecutionsResponse_calculations :: Lens' ListCalculationExecutionsResponse (Maybe [CalculationSummary])

A list of CalculationSummary objects.

listCalculationExecutionsResponse_nextToken :: Lens' ListCalculationExecutionsResponse (Maybe Text)

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.

listCalculationExecutionsResponse_httpStatus :: Lens' ListCalculationExecutionsResponse Int

The response's http status code.

ListDataCatalogs

listDataCatalogs_maxResults :: Lens' ListDataCatalogs (Maybe Natural)

Specifies the maximum number of data catalogs to return.

listDataCatalogs_nextToken :: Lens' ListDataCatalogs (Maybe Text)

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.

listDataCatalogsResponse_dataCatalogsSummary :: Lens' ListDataCatalogsResponse (Maybe [DataCatalogSummary])

A summary list of data catalogs.

listDataCatalogsResponse_nextToken :: Lens' ListDataCatalogsResponse (Maybe Text)

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.

listDataCatalogsResponse_httpStatus :: Lens' ListDataCatalogsResponse Int

The response's http status code.

ListDatabases

listDatabases_maxResults :: Lens' ListDatabases (Maybe Natural)

Specifies the maximum number of results to return.

listDatabases_nextToken :: Lens' ListDatabases (Maybe Text)

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.

listDatabases_catalogName :: Lens' ListDatabases Text

The name of the data catalog that contains the databases to return.

listDatabasesResponse_databaseList :: Lens' ListDatabasesResponse (Maybe [Database])

A list of databases from a data catalog.

listDatabasesResponse_nextToken :: Lens' ListDatabasesResponse (Maybe Text)

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.

listDatabasesResponse_httpStatus :: Lens' ListDatabasesResponse Int

The response's http status code.

ListEngineVersions

listEngineVersions_maxResults :: Lens' ListEngineVersions (Maybe Natural)

The maximum number of engine versions to return in this request.

listEngineVersions_nextToken :: Lens' ListEngineVersions (Maybe Text)

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.

listEngineVersionsResponse_engineVersions :: Lens' ListEngineVersionsResponse (Maybe [EngineVersion])

A list of engine versions that are available to choose from.

listEngineVersionsResponse_nextToken :: Lens' ListEngineVersionsResponse (Maybe Text)

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.

listEngineVersionsResponse_httpStatus :: Lens' ListEngineVersionsResponse Int

The response's http status code.

ListExecutors

listExecutors_executorStateFilter :: Lens' ListExecutors (Maybe ExecutorState)

A filter for a specific executor state. A description of each state follows.

CREATING - The executor is being started, including acquiring resources.

CREATED - The executor has been started.

REGISTERED - The executor has been registered.

TERMINATING - The executor is in the process of shutting down.

TERMINATED - The executor is no longer running.

FAILED - Due to a failure, the executor is no longer running.

listExecutors_maxResults :: Lens' ListExecutors (Maybe Natural)

The maximum number of executors to return.

listExecutors_nextToken :: Lens' ListExecutors (Maybe Text)

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.

listExecutors_sessionId :: Lens' ListExecutors Text

The session ID.

listExecutorsResponse_executorsSummary :: Lens' ListExecutorsResponse (Maybe [ExecutorsSummary])

Contains summary information about the executor.

listExecutorsResponse_nextToken :: Lens' ListExecutorsResponse (Maybe Text)

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.

listExecutorsResponse_httpStatus :: Lens' ListExecutorsResponse Int

The response's http status code.

listExecutorsResponse_sessionId :: Lens' ListExecutorsResponse Text

The session ID.

ListNamedQueries

listNamedQueries_maxResults :: Lens' ListNamedQueries (Maybe Natural)

The maximum number of queries to return in this request.

listNamedQueries_nextToken :: Lens' ListNamedQueries (Maybe Text)

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.

listNamedQueries_workGroup :: Lens' ListNamedQueries (Maybe Text)

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.

listNamedQueriesResponse_namedQueryIds :: Lens' ListNamedQueriesResponse (Maybe (NonEmpty Text))

The list of unique query IDs.

listNamedQueriesResponse_nextToken :: Lens' ListNamedQueriesResponse (Maybe Text)

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.

listNamedQueriesResponse_httpStatus :: Lens' ListNamedQueriesResponse Int

The response's http status code.

ListNotebookMetadata

listNotebookMetadata_filters :: Lens' ListNotebookMetadata (Maybe FilterDefinition)

Search filter string.

listNotebookMetadata_maxResults :: Lens' ListNotebookMetadata (Maybe Natural)

Specifies the maximum number of results to return.

listNotebookMetadata_nextToken :: Lens' ListNotebookMetadata (Maybe Text)

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

listNotebookMetadata_workGroup :: Lens' ListNotebookMetadata Text

The name of the Spark enabled workgroup to retrieve notebook metadata for.

listNotebookMetadataResponse_nextToken :: Lens' ListNotebookMetadataResponse (Maybe Text)

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.

listNotebookMetadataResponse_notebookMetadataList :: Lens' ListNotebookMetadataResponse (Maybe [NotebookMetadata])

The list of notebook metadata for the specified workgroup.

listNotebookMetadataResponse_httpStatus :: Lens' ListNotebookMetadataResponse Int

The response's http status code.

ListNotebookSessions

listNotebookSessions_maxResults :: Lens' ListNotebookSessions (Maybe Natural)

The maximum number of notebook sessions to return.

listNotebookSessions_nextToken :: Lens' ListNotebookSessions (Maybe Text)

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.

listNotebookSessions_notebookId :: Lens' ListNotebookSessions Text

The ID of the notebook to list sessions for.

listNotebookSessionsResponse_nextToken :: Lens' ListNotebookSessionsResponse (Maybe Text)

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.

listNotebookSessionsResponse_httpStatus :: Lens' ListNotebookSessionsResponse Int

The response's http status code.

listNotebookSessionsResponse_notebookSessionsList :: Lens' ListNotebookSessionsResponse [NotebookSessionSummary]

A list of the sessions belonging to the notebook.

ListPreparedStatements

listPreparedStatements_maxResults :: Lens' ListPreparedStatements (Maybe Natural)

The maximum number of results to return in this request.

listPreparedStatements_nextToken :: Lens' ListPreparedStatements (Maybe Text)

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.

listPreparedStatements_workGroup :: Lens' ListPreparedStatements Text

The workgroup to list the prepared statements for.

listPreparedStatementsResponse_nextToken :: Lens' ListPreparedStatementsResponse (Maybe Text)

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.

listPreparedStatementsResponse_preparedStatements :: Lens' ListPreparedStatementsResponse (Maybe [PreparedStatementSummary])

The list of prepared statements for the workgroup.

listPreparedStatementsResponse_httpStatus :: Lens' ListPreparedStatementsResponse Int

The response's http status code.

ListQueryExecutions

listQueryExecutions_maxResults :: Lens' ListQueryExecutions (Maybe Natural)

The maximum number of query executions to return in this request.

listQueryExecutions_nextToken :: Lens' ListQueryExecutions (Maybe Text)

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.

listQueryExecutions_workGroup :: Lens' ListQueryExecutions (Maybe Text)

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.

listQueryExecutionsResponse_nextToken :: Lens' ListQueryExecutionsResponse (Maybe Text)

A token to be used by the next request if this request is truncated.

listQueryExecutionsResponse_queryExecutionIds :: Lens' ListQueryExecutionsResponse (Maybe (NonEmpty Text))

The unique IDs of each query execution as an array of strings.

listQueryExecutionsResponse_httpStatus :: Lens' ListQueryExecutionsResponse Int

The response's http status code.

ListSessions

listSessions_maxResults :: Lens' ListSessions (Maybe Natural)

The maximum number of sessions to return.

listSessions_nextToken :: Lens' ListSessions (Maybe Text)

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.

listSessions_stateFilter :: Lens' ListSessions (Maybe SessionState)

A filter for a specific session state. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

listSessions_workGroup :: Lens' ListSessions Text

The workgroup to which the session belongs.

listSessionsResponse_nextToken :: Lens' ListSessionsResponse (Maybe Text)

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.

listSessionsResponse_sessions :: Lens' ListSessionsResponse (Maybe [SessionSummary])

A list of sessions.

listSessionsResponse_httpStatus :: Lens' ListSessionsResponse Int

The response's http status code.

ListTableMetadata

listTableMetadata_expression :: Lens' ListTableMetadata (Maybe Text)

A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

listTableMetadata_maxResults :: Lens' ListTableMetadata (Maybe Natural)

Specifies the maximum number of results to return.

listTableMetadata_nextToken :: Lens' ListTableMetadata (Maybe Text)

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.

listTableMetadata_catalogName :: Lens' ListTableMetadata Text

The name of the data catalog for which table metadata should be returned.

listTableMetadata_databaseName :: Lens' ListTableMetadata Text

The name of the database for which table metadata should be returned.

listTableMetadataResponse_nextToken :: Lens' ListTableMetadataResponse (Maybe Text)

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.

listTableMetadataResponse_tableMetadataList :: Lens' ListTableMetadataResponse (Maybe [TableMetadata])

A list of table metadata.

listTableMetadataResponse_httpStatus :: Lens' ListTableMetadataResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural)

The maximum number of results to be returned per request that lists the tags for the resource.

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)

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.

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text

Lists the tags for the resource with the specified ARN.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)

A token to be used by the next request if this request is truncated.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])

The list of tags associated with the specified resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

ListWorkGroups

listWorkGroups_maxResults :: Lens' ListWorkGroups (Maybe Natural)

The maximum number of workgroups to return in this request.

listWorkGroups_nextToken :: Lens' ListWorkGroups (Maybe Text)

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.

listWorkGroupsResponse_nextToken :: Lens' ListWorkGroupsResponse (Maybe Text)

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.

listWorkGroupsResponse_workGroups :: Lens' ListWorkGroupsResponse (Maybe [WorkGroupSummary])

A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.

listWorkGroupsResponse_httpStatus :: Lens' ListWorkGroupsResponse Int

The response's http status code.

StartCalculationExecution

startCalculationExecution_calculationConfiguration :: Lens' StartCalculationExecution (Maybe CalculationConfiguration)

Contains configuration information for the calculation.

startCalculationExecution_clientRequestToken :: Lens' StartCalculationExecution (Maybe Text)

A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

startCalculationExecution_codeBlock :: Lens' StartCalculationExecution (Maybe Text)

A string that contains the code of the calculation.

startCalculationExecution_description :: Lens' StartCalculationExecution (Maybe Text)

A description of the calculation.

startCalculationExecution_sessionId :: Lens' StartCalculationExecution Text

The session ID.

startCalculationExecutionResponse_calculationExecutionId :: Lens' StartCalculationExecutionResponse (Maybe Text)

The calculation execution UUID.

startCalculationExecutionResponse_state :: Lens' StartCalculationExecutionResponse (Maybe CalculationExecutionState)

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

startCalculationExecutionResponse_httpStatus :: Lens' StartCalculationExecutionResponse Int

The response's http status code.

StartQueryExecution

startQueryExecution_clientRequestToken :: Lens' StartQueryExecution (Maybe Text)

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

startQueryExecution_executionParameters :: Lens' StartQueryExecution (Maybe (NonEmpty Text))

A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

startQueryExecution_queryExecutionContext :: Lens' StartQueryExecution (Maybe QueryExecutionContext)

The database within which the query executes.

startQueryExecution_resultConfiguration :: Lens' StartQueryExecution (Maybe ResultConfiguration)

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

startQueryExecution_resultReuseConfiguration :: Lens' StartQueryExecution (Maybe ResultReuseConfiguration)

Specifies the query result reuse behavior for the query.

startQueryExecution_workGroup :: Lens' StartQueryExecution (Maybe Text)

The name of the workgroup in which the query is being started.

startQueryExecution_queryString :: Lens' StartQueryExecution Text

The SQL query statements to be executed.

startQueryExecutionResponse_queryExecutionId :: Lens' StartQueryExecutionResponse (Maybe Text)

The unique ID of the query that ran as a result of this request.

startQueryExecutionResponse_httpStatus :: Lens' StartQueryExecutionResponse Int

The response's http status code.

StartSession

startSession_clientRequestToken :: Lens' StartSession (Maybe Text)

A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

startSession_description :: Lens' StartSession (Maybe Text)

The session description.

startSession_notebookVersion :: Lens' StartSession (Maybe Text)

The notebook version. This value is required only when requesting that a notebook server be started for the session. The only valid notebook version is Jupyter1.0.

startSession_sessionIdleTimeoutInMinutes :: Lens' StartSession (Maybe Natural)

The idle timeout in minutes for the session.

startSession_workGroup :: Lens' StartSession Text

The workgroup to which the session belongs.

startSession_engineConfiguration :: Lens' StartSession EngineConfiguration

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

startSessionResponse_sessionId :: Lens' StartSessionResponse (Maybe Text)

The session ID.

startSessionResponse_state :: Lens' StartSessionResponse (Maybe SessionState)

The state of the session. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

startSessionResponse_httpStatus :: Lens' StartSessionResponse Int

The response's http status code.

StopCalculationExecution

stopCalculationExecution_calculationExecutionId :: Lens' StopCalculationExecution Text

The calculation execution UUID.

stopCalculationExecutionResponse_state :: Lens' StopCalculationExecutionResponse (Maybe CalculationExecutionState)

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

stopCalculationExecutionResponse_httpStatus :: Lens' StopCalculationExecutionResponse Int

The response's http status code.

StopQueryExecution

stopQueryExecution_queryExecutionId :: Lens' StopQueryExecution Text

The unique ID of the query execution to stop.

stopQueryExecutionResponse_httpStatus :: Lens' StopQueryExecutionResponse Int

The response's http status code.

TagResource

tagResource_resourceARN :: Lens' TagResource Text

Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are to be added.

tagResource_tags :: Lens' TagResource [Tag]

A collection of one or more tags, separated by commas, to be added to an Athena workgroup or data catalog resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

The response's http status code.

TerminateSession

terminateSession_sessionId :: Lens' TerminateSession Text

The session ID.

terminateSessionResponse_state :: Lens' TerminateSessionResponse (Maybe SessionState)

The state of the session. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

terminateSessionResponse_httpStatus :: Lens' TerminateSessionResponse Int

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text

Specifies the ARN of the resource from which tags are to be removed.

untagResource_tagKeys :: Lens' UntagResource [Text]

A comma-separated list of one or more tag keys whose tags are to be removed from the specified resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int

The response's http status code.

UpdateDataCatalog

updateDataCatalog_description :: Lens' UpdateDataCatalog (Maybe Text)

New or modified text that describes the data catalog.

updateDataCatalog_parameters :: Lens' UpdateDataCatalog (Maybe (HashMap Text Text))

Specifies the Lambda function or functions to use for updating 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

updateDataCatalog_name :: Lens' UpdateDataCatalog Text

The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

updateDataCatalog_type :: Lens' UpdateDataCatalog DataCatalogType

Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

updateDataCatalogResponse_httpStatus :: Lens' UpdateDataCatalogResponse Int

The response's http status code.

UpdateNamedQuery

updateNamedQuery_description :: Lens' UpdateNamedQuery (Maybe Text)

The query description.

updateNamedQuery_namedQueryId :: Lens' UpdateNamedQuery Text

The unique identifier (UUID) of the query.

updateNamedQuery_name :: Lens' UpdateNamedQuery Text

The name of the query.

updateNamedQuery_queryString :: Lens' UpdateNamedQuery Text

The contents of the query with all query statements.

updateNamedQueryResponse_httpStatus :: Lens' UpdateNamedQueryResponse Int

The response's http status code.

UpdateNotebook

updateNotebook_clientRequestToken :: Lens' UpdateNotebook (Maybe Text)

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

updateNotebook_sessionId :: Lens' UpdateNotebook (Maybe Text)

The ID of the session in which the notebook will be updated.

updateNotebook_notebookId :: Lens' UpdateNotebook Text

The ID of the notebook to update.

updateNotebook_payload :: Lens' UpdateNotebook Text

The updated content for the notebook.

updateNotebook_type :: Lens' UpdateNotebook NotebookType

The notebook content type. Currently, the only valid type is IPYNB.

updateNotebookResponse_httpStatus :: Lens' UpdateNotebookResponse Int

The response's http status code.

UpdateNotebookMetadata

updateNotebookMetadata_clientRequestToken :: Lens' UpdateNotebookMetadata (Maybe Text)

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

updateNotebookMetadata_notebookId :: Lens' UpdateNotebookMetadata Text

The ID of the notebook to update the metadata for.

updateNotebookMetadata_name :: Lens' UpdateNotebookMetadata Text

The name to update the notebook to.

updateNotebookMetadataResponse_httpStatus :: Lens' UpdateNotebookMetadataResponse Int

The response's http status code.

UpdatePreparedStatement

updatePreparedStatement_description :: Lens' UpdatePreparedStatement (Maybe Text)

The description of the prepared statement.

updatePreparedStatement_statementName :: Lens' UpdatePreparedStatement Text

The name of the prepared statement.

updatePreparedStatement_workGroup :: Lens' UpdatePreparedStatement Text

The workgroup for the prepared statement.

updatePreparedStatement_queryStatement :: Lens' UpdatePreparedStatement Text

The query string for the prepared statement.

updatePreparedStatementResponse_httpStatus :: Lens' UpdatePreparedStatementResponse Int

The response's http status code.

UpdateWorkGroup

updateWorkGroup_configurationUpdates :: Lens' UpdateWorkGroup (Maybe WorkGroupConfigurationUpdates)

Contains configuration updates for an Athena SQL workgroup.

updateWorkGroup_description :: Lens' UpdateWorkGroup (Maybe Text)

The workgroup description.

updateWorkGroup_state :: Lens' UpdateWorkGroup (Maybe WorkGroupState)

The workgroup state that will be updated for the given workgroup.

updateWorkGroup_workGroup :: Lens' UpdateWorkGroup Text

The specified workgroup that will be updated.

updateWorkGroupResponse_httpStatus :: Lens' UpdateWorkGroupResponse Int

The response's http status code.

Types

AclConfiguration

aclConfiguration_s3AclOption :: Lens' AclConfiguration S3AclOption

The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.

ApplicationDPUSizes

applicationDPUSizes_applicationRuntimeId :: Lens' ApplicationDPUSizes (Maybe Text)

The name of the supported application runtime (for example, Jupyter 1.0).

applicationDPUSizes_supportedDPUSizes :: Lens' ApplicationDPUSizes (Maybe [Int])

A list of the supported DPU sizes that the application runtime supports.

AthenaError

athenaError_errorCategory :: Lens' AthenaError (Maybe Natural)

An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.

1 - System

2 - User

3 - Other

athenaError_errorMessage :: Lens' AthenaError (Maybe Text)

Contains a short description of the error that occurred.

athenaError_errorType :: Lens' AthenaError (Maybe Natural)

An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.

athenaError_retryable :: Lens' AthenaError (Maybe Bool)

True if the query might succeed if resubmitted.

CalculationConfiguration

calculationConfiguration_codeBlock :: Lens' CalculationConfiguration (Maybe Text)

A string that contains the code for the calculation.

CalculationResult

calculationResult_resultS3Uri :: Lens' CalculationResult (Maybe Text)

The Amazon S3 location of the folder for the calculation results.

calculationResult_resultType :: Lens' CalculationResult (Maybe Text)

The data format of the calculation result.

calculationResult_stdErrorS3Uri :: Lens' CalculationResult (Maybe Text)

The Amazon S3 location of the stderr error messages file for the calculation.

calculationResult_stdOutS3Uri :: Lens' CalculationResult (Maybe Text)

The Amazon S3 location of the stdout file for the calculation.

CalculationStatistics

calculationStatistics_dpuExecutionInMillis :: Lens' CalculationStatistics (Maybe Integer)

The data processing unit execution time in milliseconds for the calculation.

calculationStatistics_progress :: Lens' CalculationStatistics (Maybe Text)

The progress of the calculation.

CalculationStatus

calculationStatus_completionDateTime :: Lens' CalculationStatus (Maybe UTCTime)

The date and time the calculation completed processing.

calculationStatus_state :: Lens' CalculationStatus (Maybe CalculationExecutionState)

The state of the calculation execution. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

calculationStatus_stateChangeReason :: Lens' CalculationStatus (Maybe Text)

The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

calculationStatus_submissionDateTime :: Lens' CalculationStatus (Maybe UTCTime)

The date and time the calculation was submitted for processing.

CalculationSummary

calculationSummary_calculationExecutionId :: Lens' CalculationSummary (Maybe Text)

The calculation execution UUID.

calculationSummary_description :: Lens' CalculationSummary (Maybe Text)

A description of the calculation.

calculationSummary_status :: Lens' CalculationSummary (Maybe CalculationStatus)

Contains information about the status of the calculation.

Column

column_comment :: Lens' Column (Maybe Text)

Optional information about the column.

column_type :: Lens' Column (Maybe Text)

The data type of the column.

column_name :: Lens' Column Text

The name of the column.

ColumnInfo

columnInfo_caseSensitive :: Lens' ColumnInfo (Maybe Bool)

Indicates whether values in the column are case-sensitive.

columnInfo_catalogName :: Lens' ColumnInfo (Maybe Text)

The catalog to which the query results belong.

columnInfo_label :: Lens' ColumnInfo (Maybe Text)

A column label.

columnInfo_nullable :: Lens' ColumnInfo (Maybe ColumnNullable)

Indicates the column's nullable status.

columnInfo_precision :: Lens' ColumnInfo (Maybe Int)

For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

columnInfo_scale :: Lens' ColumnInfo (Maybe Int)

For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

columnInfo_schemaName :: Lens' ColumnInfo (Maybe Text)

The schema name (database name) to which the query results belong.

columnInfo_tableName :: Lens' ColumnInfo (Maybe Text)

The table name for the query results.

columnInfo_name :: Lens' ColumnInfo Text

The name of the column.

columnInfo_type :: Lens' ColumnInfo Text

The data type of the column.

CustomerContentEncryptionConfiguration

customerContentEncryptionConfiguration_kmsKey :: Lens' CustomerContentEncryptionConfiguration Text

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

DataCatalog

dataCatalog_description :: Lens' DataCatalog (Maybe Text)

An optional description of the data catalog.

dataCatalog_parameters :: Lens' DataCatalog (Maybe (HashMap Text Text))

Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.

• For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.

  metadata-function=lambda_arn, sdk-version=version_number

• For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.

  • If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.

    metadata-function=lambda_arn, record-function=lambda_arn

  • If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.

    function=lambda_arn

• The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the Amazon Web Services account to which the Glue catalog belongs.

  catalog-id=catalog_id

  • The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.
  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

dataCatalog_name :: Lens' DataCatalog Text

The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

dataCatalog_type :: Lens' DataCatalog DataCatalogType

The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

DataCatalogSummary

dataCatalogSummary_catalogName :: Lens' DataCatalogSummary (Maybe Text)

The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.

dataCatalogSummary_type :: Lens' DataCatalogSummary (Maybe DataCatalogType)

The data catalog type.

Database

database_description :: Lens' Database (Maybe Text)

An optional description of the database.

database_parameters :: Lens' Database (Maybe (HashMap Text Text))

A set of custom key/value pairs.

database_name :: Lens' Database Text

The name of the database.

Datum

datum_varCharValue :: Lens' Datum (Maybe Text)

The value of the datum.

EncryptionConfiguration

encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration (Maybe Text)

For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

encryptionConfiguration_encryptionOption :: Lens' EncryptionConfiguration EncryptionOption

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.

EngineConfiguration

engineConfiguration_additionalConfigs :: Lens' EngineConfiguration (Maybe (HashMap Text Text))

Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Amazon S3 URI that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookFileURI to AdditionalConfigs that has value of the Amazon S3 URI.

engineConfiguration_coordinatorDpuSize :: Lens' EngineConfiguration (Maybe Natural)

The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.

engineConfiguration_defaultExecutorDpuSize :: Lens' EngineConfiguration (Maybe Natural)

The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.

engineConfiguration_maxConcurrentDpus :: Lens' EngineConfiguration Natural

The maximum number of DPUs that can run concurrently.

EngineVersion

engineVersion_effectiveEngineVersion :: Lens' EngineVersion (Maybe Text)

Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

engineVersion_selectedEngineVersion :: Lens' EngineVersion (Maybe Text)

The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including Auto. The default is Auto.

ExecutorsSummary

executorsSummary_executorSize :: Lens' ExecutorsSummary (Maybe Integer)

The smallest unit of compute that a session can request from Athena. Size is measured in data processing unit (DPU) values, a relative measure of processing power.

executorsSummary_executorState :: Lens' ExecutorsSummary (Maybe ExecutorState)

The processing state of the executor. A description of each state follows.

CREATING - The executor is being started, including acquiring resources.

CREATED - The executor has been started.

REGISTERED - The executor has been registered.

TERMINATING - The executor is in the process of shutting down.

TERMINATED - The executor is no longer running.

FAILED - Due to a failure, the executor is no longer running.

executorsSummary_executorType :: Lens' ExecutorsSummary (Maybe ExecutorType)

The type of executor used for the application (COORDINATOR, GATEWAY, or WORKER).

executorsSummary_startDateTime :: Lens' ExecutorsSummary (Maybe Integer)

The date and time that the executor started.

executorsSummary_terminationDateTime :: Lens' ExecutorsSummary (Maybe Integer)

The date and time that the executor was terminated.

executorsSummary_executorId :: Lens' ExecutorsSummary Text

The UUID of the executor.

FilterDefinition

filterDefinition_name :: Lens' FilterDefinition (Maybe Text)

The name of the notebook to search for.

NamedQuery

namedQuery_description :: Lens' NamedQuery (Maybe Text)

The query description.

namedQuery_namedQueryId :: Lens' NamedQuery (Maybe Text)

The unique identifier of the query.

namedQuery_workGroup :: Lens' NamedQuery (Maybe Text)

The name of the workgroup that contains the named query.

namedQuery_name :: Lens' NamedQuery Text

The query name.

namedQuery_database :: Lens' NamedQuery Text

The database to which the query belongs.

namedQuery_queryString :: Lens' NamedQuery Text

The SQL statements that make up the query.

NotebookMetadata

notebookMetadata_creationTime :: Lens' NotebookMetadata (Maybe UTCTime)

The time when the notebook was created.

notebookMetadata_lastModifiedTime :: Lens' NotebookMetadata (Maybe UTCTime)

The time when the notebook was last modified.

notebookMetadata_name :: Lens' NotebookMetadata (Maybe Text)

The name of the notebook.

notebookMetadata_notebookId :: Lens' NotebookMetadata (Maybe Text)

The notebook ID.

notebookMetadata_type :: Lens' NotebookMetadata (Maybe NotebookType)

The type of notebook. Currently, the only valid type is IPYNB.

notebookMetadata_workGroup :: Lens' NotebookMetadata (Maybe Text)

The name of the Spark enabled workgroup to which the notebook belongs.

NotebookSessionSummary

notebookSessionSummary_creationTime :: Lens' NotebookSessionSummary (Maybe UTCTime)

The time when the notebook session was created.

notebookSessionSummary_sessionId :: Lens' NotebookSessionSummary (Maybe Text)

The notebook session ID.

PreparedStatement

preparedStatement_description :: Lens' PreparedStatement (Maybe Text)

The description of the prepared statement.

preparedStatement_lastModifiedTime :: Lens' PreparedStatement (Maybe UTCTime)

The last modified time of the prepared statement.

preparedStatement_queryStatement :: Lens' PreparedStatement (Maybe Text)

The query string for the prepared statement.

preparedStatement_statementName :: Lens' PreparedStatement (Maybe Text)

The name of the prepared statement.

preparedStatement_workGroupName :: Lens' PreparedStatement (Maybe Text)

The name of the workgroup to which the prepared statement belongs.

PreparedStatementSummary

preparedStatementSummary_lastModifiedTime :: Lens' PreparedStatementSummary (Maybe UTCTime)

The last modified time of the prepared statement.

preparedStatementSummary_statementName :: Lens' PreparedStatementSummary (Maybe Text)

The name of the prepared statement.

QueryExecution

queryExecution_engineVersion :: Lens' QueryExecution (Maybe EngineVersion)

The engine version that executed the query.

queryExecution_executionParameters :: Lens' QueryExecution (Maybe (NonEmpty Text))

A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

queryExecution_query :: Lens' QueryExecution (Maybe Text)

The SQL query statements which the query execution ran.

queryExecution_queryExecutionContext :: Lens' QueryExecution (Maybe QueryExecutionContext)

The database in which the query execution occurred.

queryExecution_queryExecutionId :: Lens' QueryExecution (Maybe Text)

The unique identifier for each query execution.

queryExecution_resultConfiguration :: Lens' QueryExecution (Maybe ResultConfiguration)

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.

queryExecution_resultReuseConfiguration :: Lens' QueryExecution (Maybe ResultReuseConfiguration)

Specifies the query result reuse behavior that was used for the query.

queryExecution_statementType :: Lens' QueryExecution (Maybe StatementType)

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.

queryExecution_statistics :: Lens' QueryExecution (Maybe QueryExecutionStatistics)

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.

queryExecution_status :: Lens' QueryExecution (Maybe QueryExecutionStatus)

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

queryExecution_workGroup :: Lens' QueryExecution (Maybe Text)

The name of the workgroup in which the query ran.

QueryExecutionContext

queryExecutionContext_catalog :: Lens' QueryExecutionContext (Maybe Text)

The name of the data catalog used in the query execution.

queryExecutionContext_database :: Lens' QueryExecutionContext (Maybe Text)

The name of the database used in the query execution. The database must exist in the catalog.

QueryExecutionStatistics

queryExecutionStatistics_dataManifestLocation :: Lens' QueryExecutionStatistics (Maybe Text)

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.

queryExecutionStatistics_dataScannedInBytes :: Lens' QueryExecutionStatistics (Maybe Integer)

The number of bytes in the data that was queried.

queryExecutionStatistics_engineExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)

The number of milliseconds that the query took to execute.

queryExecutionStatistics_queryPlanningTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)

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.

queryExecutionStatistics_queryQueueTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)

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.

queryExecutionStatistics_resultReuseInformation :: Lens' QueryExecutionStatistics (Maybe ResultReuseInformation)

Contains information about whether previous query results were reused for the query.

queryExecutionStatistics_serviceProcessingTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)

The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

queryExecutionStatistics_totalExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)

The number of milliseconds that Athena took to run the query.

QueryExecutionStatus

queryExecutionStatus_athenaError :: Lens' QueryExecutionStatus (Maybe AthenaError)

Provides information about an Athena query error.

queryExecutionStatus_completionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)

The date and time that the query completed.

queryExecutionStatus_state :: Lens' QueryExecutionStatus (Maybe QueryExecutionState)

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.

queryExecutionStatus_stateChangeReason :: Lens' QueryExecutionStatus (Maybe Text)

Further detail about the status of the query.

queryExecutionStatus_submissionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)

The date and time that the query was submitted.

QueryRuntimeStatistics

queryRuntimeStatistics_outputStage :: Lens' QueryRuntimeStatistics (Maybe 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.

queryRuntimeStatistics_rows :: Lens' QueryRuntimeStatistics (Maybe QueryRuntimeStatisticsRows)

Undocumented member.

queryRuntimeStatistics_timeline :: Lens' QueryRuntimeStatistics (Maybe QueryRuntimeStatisticsTimeline)

Undocumented member.

QueryRuntimeStatisticsRows

queryRuntimeStatisticsRows_inputBytes :: Lens' QueryRuntimeStatisticsRows (Maybe Integer)

The number of bytes read to execute the query.

queryRuntimeStatisticsRows_inputRows :: Lens' QueryRuntimeStatisticsRows (Maybe Integer)

The number of rows read to execute the query.

queryRuntimeStatisticsRows_outputBytes :: Lens' QueryRuntimeStatisticsRows (Maybe Integer)

The number of bytes returned by the query.

queryRuntimeStatisticsRows_outputRows :: Lens' QueryRuntimeStatisticsRows (Maybe Integer)

The number of rows returned by the query.

QueryRuntimeStatisticsTimeline

queryRuntimeStatisticsTimeline_engineExecutionTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)

The number of milliseconds that the query took to execute.

queryRuntimeStatisticsTimeline_queryPlanningTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)

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.

queryRuntimeStatisticsTimeline_queryQueueTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)

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.

queryRuntimeStatisticsTimeline_serviceProcessingTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)

The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

queryRuntimeStatisticsTimeline_totalExecutionTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)

The number of milliseconds that Athena took to run the query.

QueryStage

queryStage_executionTime :: Lens' QueryStage (Maybe Integer)

Time taken to execute this stage.

queryStage_inputBytes :: Lens' QueryStage (Maybe Integer)

The number of bytes input into the stage for execution.

queryStage_inputRows :: Lens' QueryStage (Maybe Integer)

The number of rows input into the stage for execution.

queryStage_outputBytes :: Lens' QueryStage (Maybe Integer)

The number of bytes output from the stage after execution.

queryStage_outputRows :: Lens' QueryStage (Maybe Integer)

The number of rows output from the stage after execution.

queryStage_queryStagePlan :: Lens' QueryStage (Maybe QueryStagePlanNode)

Stage plan information such as name, identifier, sub plans, and source stages.

queryStage_stageId :: Lens' QueryStage (Maybe Integer)

The identifier for a stage.

queryStage_state :: Lens' QueryStage (Maybe Text)

State of the stage after query execution.

queryStage_subStages :: Lens' QueryStage (Maybe [QueryStage])

List of sub query stages that form this stage execution plan.

QueryStagePlanNode

queryStagePlanNode_children :: Lens' QueryStagePlanNode (Maybe [QueryStagePlanNode])

Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/

queryStagePlanNode_identifier :: Lens' QueryStagePlanNode (Maybe Text)

Information about the operation this query stage plan node is performing.

queryStagePlanNode_name :: Lens' QueryStagePlanNode (Maybe Text)

Name of the query stage plan that describes the operation this stage is performing as part of query execution.

queryStagePlanNode_remoteSources :: Lens' QueryStagePlanNode (Maybe [Text])

Source plan node IDs.

ResultConfiguration

resultConfiguration_aclConfiguration :: Lens' ResultConfiguration (Maybe AclConfiguration)

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

resultConfiguration_encryptionConfiguration :: Lens' ResultConfiguration (Maybe EncryptionConfiguration)

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

resultConfiguration_expectedBucketOwner :: Lens' ResultConfiguration (Maybe Text)

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

resultConfiguration_outputLocation :: Lens' ResultConfiguration (Maybe Text)

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 none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

ResultConfigurationUpdates

resultConfigurationUpdates_aclConfiguration :: Lens' ResultConfigurationUpdates (Maybe AclConfiguration)

The ACL configuration for the query results.

resultConfigurationUpdates_encryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe EncryptionConfiguration)

The encryption configuration for the query results.

resultConfigurationUpdates_expectedBucketOwner :: Lens' ResultConfigurationUpdates (Maybe Text)

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

resultConfigurationUpdates_outputLocation :: Lens' ResultConfigurationUpdates (Maybe Text)

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. For more information, see Query Results 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. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

resultConfigurationUpdates_removeAclConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool)

If set to true, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to false or not set, and a value is present in the AclConfiguration of ResultConfigurationUpdates, the AclConfiguration in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

resultConfigurationUpdates_removeEncryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool)

If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

resultConfigurationUpdates_removeExpectedBucketOwner :: Lens' ResultConfigurationUpdates (Maybe Bool)

If set to "true", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to "false" or not set, and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

resultConfigurationUpdates_removeOutputLocation :: Lens' ResultConfigurationUpdates (Maybe Bool)

If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

ResultReuseByAgeConfiguration

resultReuseByAgeConfiguration_maxAgeInMinutes :: Lens' ResultReuseByAgeConfiguration (Maybe Natural)

Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.

resultReuseByAgeConfiguration_enabled :: Lens' ResultReuseByAgeConfiguration Bool

True if previous query results can be reused when the query is run; otherwise, false. The default is false.

ResultReuseConfiguration

resultReuseConfiguration_resultReuseByAgeConfiguration :: Lens' ResultReuseConfiguration (Maybe ResultReuseByAgeConfiguration)

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

ResultReuseInformation

resultReuseInformation_reusedPreviousResult :: Lens' ResultReuseInformation Bool

True if a previous query result was reused; false if the result was generated from a new run of the query.

ResultSet

resultSet_resultSetMetadata :: Lens' ResultSet (Maybe ResultSetMetadata)

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

resultSet_rows :: Lens' ResultSet (Maybe [Row])

The rows in the table.

ResultSetMetadata

resultSetMetadata_columnInfo :: Lens' ResultSetMetadata (Maybe [ColumnInfo])

Information about the columns returned in a query result metadata.

Row

row_data :: Lens' Row (Maybe [Datum])

The data that populates a row in a query result table.

SessionConfiguration

sessionConfiguration_encryptionConfiguration :: Lens' SessionConfiguration (Maybe EncryptionConfiguration)

Undocumented member.

sessionConfiguration_executionRole :: Lens' SessionConfiguration (Maybe Text)

The ARN of the execution role used for the session.

sessionConfiguration_idleTimeoutSeconds :: Lens' SessionConfiguration (Maybe Integer)

The idle timeout in seconds for the session.

sessionConfiguration_workingDirectory :: Lens' SessionConfiguration (Maybe Text)

The Amazon S3 location that stores information for the notebook.

SessionStatistics

sessionStatistics_dpuExecutionInMillis :: Lens' SessionStatistics (Maybe Integer)

The data processing unit execution time for a session in milliseconds.

SessionStatus

sessionStatus_endDateTime :: Lens' SessionStatus (Maybe UTCTime)

The date and time that the session ended.

sessionStatus_idleSinceDateTime :: Lens' SessionStatus (Maybe UTCTime)

The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

sessionStatus_lastModifiedDateTime :: Lens' SessionStatus (Maybe UTCTime)

The most recent date and time that the session was modified.

sessionStatus_startDateTime :: Lens' SessionStatus (Maybe UTCTime)

The date and time that the session started.

sessionStatus_state :: Lens' SessionStatus (Maybe SessionState)

The state of the session. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

sessionStatus_stateChangeReason :: Lens' SessionStatus (Maybe Text)

The reason for the session state change (for example, canceled because the session was terminated).

SessionSummary

sessionSummary_description :: Lens' SessionSummary (Maybe Text)

The session description.

sessionSummary_engineVersion :: Lens' SessionSummary (Maybe EngineVersion)

The engine version used by the session (for example, PySpark engine version 3).

sessionSummary_notebookVersion :: Lens' SessionSummary (Maybe Text)

The notebook version.

sessionSummary_sessionId :: Lens' SessionSummary (Maybe Text)

The session ID.

sessionSummary_status :: Lens' SessionSummary (Maybe SessionStatus)

Contains information about the session status.

TableMetadata

tableMetadata_columns :: Lens' TableMetadata (Maybe [Column])

A list of the columns in the table.

tableMetadata_createTime :: Lens' TableMetadata (Maybe UTCTime)

The time that the table was created.

tableMetadata_lastAccessTime :: Lens' TableMetadata (Maybe UTCTime)

The last time the table was accessed.

tableMetadata_parameters :: Lens' TableMetadata (Maybe (HashMap Text Text))

A set of custom key/value pairs for table properties.

tableMetadata_partitionKeys :: Lens' TableMetadata (Maybe [Column])

A list of the partition keys in the table.

tableMetadata_tableType :: Lens' TableMetadata (Maybe Text)

The type of table. In Athena, only EXTERNAL_TABLE is supported.

tableMetadata_name :: Lens' TableMetadata Text

The name of the table.

Tag

tag_key :: Lens' Tag (Maybe Text)

A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.

tag_value :: Lens' Tag (Maybe Text)

A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.

UnprocessedNamedQueryId

unprocessedNamedQueryId_errorCode :: Lens' UnprocessedNamedQueryId (Maybe Text)

The error code returned when the processing request for the named query failed, if applicable.

unprocessedNamedQueryId_errorMessage :: Lens' UnprocessedNamedQueryId (Maybe Text)

The error message returned when the processing request for the named query failed, if applicable.

unprocessedNamedQueryId_namedQueryId :: Lens' UnprocessedNamedQueryId (Maybe Text)

The unique identifier of the named query.

UnprocessedPreparedStatementName

unprocessedPreparedStatementName_errorCode :: Lens' UnprocessedPreparedStatementName (Maybe Text)

The error code returned when the request for the prepared statement failed.

unprocessedPreparedStatementName_errorMessage :: Lens' UnprocessedPreparedStatementName (Maybe Text)

The error message containing the reason why the prepared statement could not be returned. The following error messages are possible:

• INVALID_INPUT - The name of the prepared statement that was provided is not valid (for example, the name is too long).
• STATEMENT_NOT_FOUND - A prepared statement with the name provided could not be found.
• UNAUTHORIZED - The requester does not have permission to access the workgroup that contains the prepared statement.

unprocessedPreparedStatementName_statementName :: Lens' UnprocessedPreparedStatementName (Maybe Text)

The name of a prepared statement that could not be returned due to an error.

UnprocessedQueryExecutionId

unprocessedQueryExecutionId_errorCode :: Lens' UnprocessedQueryExecutionId (Maybe Text)

The error code returned when the query execution failed to process, if applicable.

unprocessedQueryExecutionId_errorMessage :: Lens' UnprocessedQueryExecutionId (Maybe Text)

The error message returned when the query execution failed to process, if applicable.

unprocessedQueryExecutionId_queryExecutionId :: Lens' UnprocessedQueryExecutionId (Maybe Text)

The unique identifier of the query execution.

WorkGroup

workGroup_configuration :: Lens' WorkGroup (Maybe WorkGroupConfiguration)

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side 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.

workGroup_creationTime :: Lens' WorkGroup (Maybe UTCTime)

The date and time the workgroup was created.

workGroup_description :: Lens' WorkGroup (Maybe Text)

The workgroup description.

workGroup_state :: Lens' WorkGroup (Maybe WorkGroupState)

The state of the workgroup: ENABLED or DISABLED.

workGroup_name :: Lens' WorkGroup Text

The workgroup name.

WorkGroupConfiguration

workGroupConfiguration_additionalConfiguration :: Lens' WorkGroupConfiguration (Maybe Text)

Specifies a user defined JSON string that is passed to the notebook engine.

workGroupConfiguration_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfiguration (Maybe Natural)

The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

workGroupConfiguration_customerContentEncryptionConfiguration :: Lens' WorkGroupConfiguration (Maybe CustomerContentEncryptionConfiguration)

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

workGroupConfiguration_enforceWorkGroupConfiguration :: Lens' WorkGroupConfiguration (Maybe Bool)

If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

workGroupConfiguration_engineVersion :: Lens' WorkGroupConfiguration (Maybe EngineVersion)

The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

workGroupConfiguration_executionRole :: Lens' WorkGroupConfiguration (Maybe Text)

Role used in a notebook session for accessing the user's resources.

workGroupConfiguration_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfiguration (Maybe Bool)

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

workGroupConfiguration_requesterPaysEnabled :: Lens' WorkGroupConfiguration (Maybe Bool)

If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

workGroupConfiguration_resultConfiguration :: Lens' WorkGroupConfiguration (Maybe ResultConfiguration)

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.

WorkGroupConfigurationUpdates

workGroupConfigurationUpdates_additionalConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Text)

Contains a user defined string in JSON format for a Spark-enabled workgroup.

workGroupConfigurationUpdates_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Natural)

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

workGroupConfigurationUpdates_customerContentEncryptionConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe CustomerContentEncryptionConfiguration)

Undocumented member.

workGroupConfigurationUpdates_enforceWorkGroupConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)

If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

workGroupConfigurationUpdates_engineVersion :: Lens' WorkGroupConfigurationUpdates (Maybe EngineVersion)

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

workGroupConfigurationUpdates_executionRole :: Lens' WorkGroupConfigurationUpdates (Maybe Text)

Contains the ARN of the execution role for the workgroup

workGroupConfigurationUpdates_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

workGroupConfigurationUpdates_removeBytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

workGroupConfigurationUpdates_removeCustomerContentEncryptionConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)

Removes content encryption configuration for a workgroup.

workGroupConfigurationUpdates_requesterPaysEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

workGroupConfigurationUpdates_resultConfigurationUpdates :: Lens' WorkGroupConfigurationUpdates (Maybe ResultConfigurationUpdates)

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

WorkGroupSummary

workGroupSummary_creationTime :: Lens' WorkGroupSummary (Maybe UTCTime)

The workgroup creation date and time.

workGroupSummary_description :: Lens' WorkGroupSummary (Maybe Text)

The workgroup description.

workGroupSummary_engineVersion :: Lens' WorkGroupSummary (Maybe EngineVersion)

The engine version setting for all queries on the workgroup. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

workGroupSummary_name :: Lens' WorkGroupSummary (Maybe Text)

The name of the workgroup.

workGroupSummary_state :: Lens' WorkGroupSummary (Maybe WorkGroupState)

The state of the workgroup.