String 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.
Integer errorCategory
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
Integer errorType
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.
Boolean retryable
True if the query might succeed if resubmitted.
String errorMessage
Contains a short description of the error that occurred.
String codeBlock
A string that contains the code for the calculation.
String stdOutS3Uri
The Amazon S3 location of the stdout
file for the calculation.
String stdErrorS3Uri
The Amazon S3 location of the stderr
error messages file for the calculation.
String resultS3Uri
The Amazon S3 location of the folder for the calculation results.
String resultType
The data format of the calculation result.
Date submissionDateTime
The date and time the calculation was submitted for processing.
Date completionDateTime
The date and time the calculation completed processing.
String state
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.
String stateChangeReason
The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).
String calculationExecutionId
The calculation execution UUID.
String description
A description of the calculation.
CalculationStatus status
Contains information about the status of the calculation.
String name
The name of the capacity reservation to cancel.
String status
The status of the capacity allocation.
String statusMessage
The status message of the capacity allocation.
Date requestTime
The time when the capacity allocation was requested.
Date requestCompletionTime
The time when the capacity allocation request was completed.
String name
The name of the capacity reservation.
String status
The status of the capacity reservation.
Integer targetDpus
The number of data processing units requested.
Integer allocatedDpus
The number of data processing units currently allocated.
CapacityAllocation lastAllocation
Date lastSuccessfulAllocationTime
The time of the most recent capacity allocation that succeeded.
Date creationTime
The time in UTC epoch millis when the capacity reservation was created.
String catalogName
The catalog to which the query results belong.
String schemaName
The schema name (database name) to which the query results belong.
String tableName
The table name for the query results.
String name
The name of the column.
String label
A column label.
String type
The data type of the column.
Integer precision
For DECIMAL
data types, specifies the total number of digits, up to 38. For performance reasons, we
recommend up to 18 digits.
Integer scale
For DECIMAL
data types, specifies the total number of digits in the fractional part of the value.
Defaults to 0.
String nullable
Indicates the column's nullable status.
Boolean caseSensitive
Indicates whether values in the column are case-sensitive.
String name
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.
String type
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.
String description
A description of the data catalog to be created.
Map<K,V> parameters
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.
List<E> tags
A list of comma separated tags to add to the data catalog that is created.
String name
The query name.
String description
The query description.
String database
The database to which the query belongs.
String queryString
The contents of the query with all query statements.
String clientRequestToken
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.
String workGroup
The name of the workgroup in which the named query is being created.
String namedQueryId
The unique ID of the query.
String workGroup
The name of the Spark enabled workgroup in which the notebook will be created.
String name
The name of the ipynb
file to be created in the Spark workgroup, without the .ipynb
extension.
String clientRequestToken
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.
String notebookId
A unique identifier for the notebook.
String statementName
The name of the prepared statement.
String workGroup
The name of the workgroup to which the prepared statement belongs.
String queryStatement
The query string for the prepared statement.
String description
The description of the prepared statement.
String sessionId
The session ID.
String notebookUrl
The URL of the notebook. The URL includes the authentication token and notebook file name and points directly to the opened notebook.
String authToken
The authentication token for the notebook.
Long authTokenExpirationTime
The UTC epoch time when the authentication token expires.
String name
The workgroup name.
WorkGroupConfiguration configuration
Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena
SQL workgroup configuration includes the location in Amazon S3 where query and calculation 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.
String description
The workgroup description.
List<E> tags
A list of comma separated tags to add to the workgroup that is created.
String kmsKey
The KMS key that is used to encrypt the user's data stores in Athena.
String name
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.
String description
An optional description of the data catalog.
String type
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.
Map<K,V> parameters
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.
String catalogName
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.
String type
The data catalog type.
String varCharValue
The value of the datum.
String name
The name of the data catalog to delete.
String namedQueryId
The unique ID of the query to delete.
String notebookId
The ID of the notebook to delete.
String 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.
String kmsKey
For SSE_KMS
and CSE_KMS
, this is the KMS key ARN or ID.
Integer coordinatorDpuSize
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. The default is 1.
Integer maxConcurrentDpus
The maximum number of DPUs that can run concurrently.
Integer defaultExecutorDpuSize
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. The default is 1.
Map<K,V> additionalConfigs
Contains additional notebook engine MAP<string, string>
parameter mappings in the form of
key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value
for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId
to
AdditionalConfigs
that has the value of the Athena notebook ID.
String selectedEngineVersion
The engine version requested by the user. Possible values are determined by the output of
ListEngineVersions
, including AUTO. The default is AUTO.
String effectiveEngineVersion
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.
String executorId
The UUID of the executor.
String executorType
The type of executor used for the application (COORDINATOR
, GATEWAY
, or
WORKER
).
Long startDateTime
The date and time that the executor started.
Long terminationDateTime
The date and time that the executor was terminated.
String 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.
Long executorSize
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.
String notebookId
The ID of the notebook to export.
NotebookMetadata notebookMetadata
The notebook metadata, including notebook ID, notebook name, and workgroup name.
String payload
The content of the exported notebook.
String name
The name of the notebook to search for.
String calculationExecutionId
The calculation execution UUID.
String codeBlock
The unencrypted code that was executed for the calculation.
String calculationExecutionId
The calculation execution UUID.
String calculationExecutionId
The calculation execution UUID.
String sessionId
The session ID that the calculation ran in.
String description
The description of the calculation execution.
String workingDirectory
The Amazon S3 location in which calculation results are stored.
CalculationStatus status
Contains information about the status of the calculation.
CalculationStatistics statistics
Contains information about the data processing unit (DPU) execution time and progress. This field is populated only when statistics are available.
CalculationResult result
Contains result information. This field is populated only if the calculation is completed.
String calculationExecutionId
The calculation execution UUID.
CalculationStatus status
Contains information about the calculation execution status.
CalculationStatistics statistics
Contains information about the DPU execution time and progress.
String capacityReservationName
The name of the capacity reservation to retrieve the capacity assignment configuration for.
CapacityAssignmentConfiguration capacityAssignmentConfiguration
The requested capacity assignment configuration for the specified capacity reservation.
String name
The name of the capacity reservation.
CapacityReservation capacityReservation
The requested capacity reservation structure.
Database database
The database returned.
String name
The name of the data catalog to return.
DataCatalog dataCatalog
The data catalog returned.
String namedQueryId
The unique ID of the query. Use ListNamedQueries to get query IDs.
NamedQuery namedQuery
Information about the query.
String notebookId
The ID of the notebook whose metadata is to be retrieved.
NotebookMetadata notebookMetadata
The metadata that is returned for the specified notebook ID.
PreparedStatement preparedStatement
The name of the prepared statement that was retrieved.
String queryExecutionId
The unique ID of the query execution.
QueryExecution queryExecution
Information about the query execution.
String queryExecutionId
The unique ID of the query execution.
String nextToken
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.
Integer maxResults
The maximum number of results (rows) to return in this request.
Long updateCount
The number of rows inserted with a CREATE TABLE AS SELECT
statement.
ResultSet resultSet
The results of the query execution.
String nextToken
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.
String queryExecutionId
The unique ID of the query execution.
QueryRuntimeStatistics queryRuntimeStatistics
Runtime statistics about the query execution.
String sessionId
The session ID.
String sessionId
The session ID.
String description
The session description.
String workGroup
The workgroup to which the session belongs.
String engineVersion
The engine version used by the session (for example, PySpark engine version 3
). You can get a list
of engine versions by calling ListEngineVersions.
EngineConfiguration engineConfiguration
Contains engine configuration information like DPU usage.
String notebookVersion
The notebook version.
SessionConfiguration sessionConfiguration
Contains the workgroup configuration information used by the session.
SessionStatus status
Contains information about the status of the session.
SessionStatistics statistics
Contains the DPU execution time.
String sessionId
The session ID.
String sessionId
The session ID.
SessionStatus status
Contains information about the status of the session.
TableMetadata tableMetadata
An object that contains table metadata.
String workGroup
The name of the workgroup.
WorkGroup workGroup
Information about the workgroup.
String workGroup
The name of the Spark enabled workgroup to import the notebook to.
String name
The name of the notebook to import.
String payload
The notebook content to be imported.
String type
The notebook content type. Currently, the only valid type is IPYNB
.
String clientRequestToken
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.
String notebookId
The ID assigned to the imported notebook.
String athenaErrorCode
List<E> applicationDPUSizes
A list of the supported DPU sizes that the application runtime supports.
String nextToken
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.
String sessionId
The session ID.
String stateFilter
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.
Integer maxResults
The maximum number of calculation executions to return.
String nextToken
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.
String nextToken
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.
List<E> calculations
A list of CalculationSummary objects.
String nextToken
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.
List<E> capacityReservations
The capacity reservations for the current account.
String catalogName
The name of the data catalog that contains the databases to return.
String nextToken
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.
Integer maxResults
Specifies the maximum number of results to return.
List<E> databaseList
A list of databases from a data catalog.
String nextToken
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.
String nextToken
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.
Integer maxResults
Specifies the maximum number of data catalogs to return.
List<E> dataCatalogsSummary
A summary list of data catalogs.
String nextToken
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.
String nextToken
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.
Integer maxResults
The maximum number of engine versions to return in this request.
List<E> engineVersions
A list of engine versions that are available to choose from.
String nextToken
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.
String sessionId
The session ID.
String executorStateFilter
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.
Integer maxResults
The maximum number of executors to return.
String nextToken
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.
String sessionId
The session ID.
String nextToken
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.
List<E> executorsSummary
Contains summary information about the executor.
String nextToken
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.
Integer maxResults
The maximum number of queries to return in this request.
String workGroup
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.
List<E> namedQueryIds
The list of unique query IDs.
String nextToken
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.
FilterDefinition filters
Search filter string.
String nextToken
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.
Integer maxResults
Specifies the maximum number of results to return.
String workGroup
The name of the Spark enabled workgroup to retrieve notebook metadata for.
String nextToken
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.
List<E> notebookMetadataList
The list of notebook metadata for the specified workgroup.
String notebookId
The ID of the notebook to list sessions for.
Integer maxResults
The maximum number of notebook sessions to return.
String nextToken
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.
List<E> notebookSessionsList
A list of the sessions belonging to the notebook.
String nextToken
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.
String workGroup
The workgroup to list the prepared statements for.
String nextToken
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.
Integer maxResults
The maximum number of results to return in this request.
List<E> preparedStatements
The list of prepared statements for the workgroup.
String nextToken
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.
String nextToken
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.
Integer maxResults
The maximum number of query executions to return in this request.
String workGroup
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.
String workGroup
The workgroup to which the session belongs.
String stateFilter
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.
Integer maxResults
The maximum number of sessions to return.
String nextToken
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.
String nextToken
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.
List<E> sessions
A list of sessions.
String catalogName
The name of the data catalog for which table metadata should be returned.
String databaseName
The name of the database for which table metadata should be returned.
String expression
A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.
String nextToken
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.
Integer maxResults
Specifies the maximum number of results to return.
List<E> tableMetadataList
A list of table metadata.
String nextToken
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.
String resourceARN
Lists the tags for the resource with the specified ARN.
String nextToken
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.
Integer maxResults
The maximum number of results to be returned per request that lists the tags for the resource.
String nextToken
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.
Integer maxResults
The maximum number of workgroups to return in this request.
List<E> workGroups
A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.
String nextToken
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.
String name
The query name.
String description
The query description.
String database
The database to which the query belongs.
String queryString
The SQL statements that make up the query.
String namedQueryId
The unique identifier of the query.
String workGroup
The name of the workgroup that contains the named query.
String notebookId
The notebook ID.
String name
The name of the notebook.
String workGroup
The name of the Spark enabled workgroup to which the notebook belongs.
Date creationTime
The time when the notebook was created.
String type
The type of notebook. Currently, the only valid type is IPYNB
.
Date lastModifiedTime
The time when the notebook was last modified.
String statementName
The name of the prepared statement.
String queryStatement
The query string for the prepared statement.
String workGroupName
The name of the workgroup to which the prepared statement belongs.
String description
The description of the prepared statement.
Date lastModifiedTime
The last modified time of the prepared statement.
String queryExecutionId
The unique identifier for each query execution.
String query
The SQL query statements which the query execution ran.
String 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
.
ResultConfiguration resultConfiguration
The location in Amazon S3 where query and calculation results are 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.
ResultReuseConfiguration resultReuseConfiguration
Specifies the query result reuse behavior that was used for the query.
QueryExecutionContext queryExecutionContext
The database in which the query execution occurred.
QueryExecutionStatus status
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
QueryExecutionStatistics statistics
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.
String workGroup
The name of the workgroup in which the query ran.
EngineVersion engineVersion
The engine version that executed the query.
List<E> executionParameters
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.
String substatementType
The kind of query statement that was run.
Long engineExecutionTimeInMillis
The number of milliseconds that the query took to execute.
Long dataScannedInBytes
The number of bytes in the data that was queried.
String dataManifestLocation
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.
Long totalExecutionTimeInMillis
The number of milliseconds that Athena took to run the query.
Long queryQueueTimeInMillis
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.
Long queryPlanningTimeInMillis
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.
Long serviceProcessingTimeInMillis
The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
ResultReuseInformation resultReuseInformation
Contains information about whether previous query results were reused for the query.
String state
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
.
String stateChangeReason
Further detail about the status of the query.
Date submissionDateTime
The date and time that the query was submitted.
Date completionDateTime
The date and time that the query completed.
AthenaError athenaError
Provides information about an Athena query error.
QueryRuntimeStatisticsTimeline timeline
QueryRuntimeStatisticsRows rows
QueryStage outputStage
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.
Long queryQueueTimeInMillis
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.
Long queryPlanningTimeInMillis
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.
Long engineExecutionTimeInMillis
The number of milliseconds that the query took to execute.
Long serviceProcessingTimeInMillis
The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
Long totalExecutionTimeInMillis
The number of milliseconds that Athena took to run the query.
Long stageId
The identifier for a stage.
String state
State of the stage after query execution.
Long outputBytes
The number of bytes output from the stage after execution.
Long outputRows
The number of rows output from the stage after execution.
Long inputBytes
The number of bytes input into the stage for execution.
Long inputRows
The number of rows input into the stage for execution.
Long executionTime
Time taken to execute this stage.
QueryStagePlanNode queryStagePlan
Stage plan information such as name, identifier, sub plans, and source stages.
List<E> subStages
List of sub query stages that form this stage execution plan.
String name
Name of the query stage plan that describes the operation this stage is performing as part of query execution.
String identifier
Information about the operation this query stage plan node is performing.
List<E> children
Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/
List<E> remoteSources
Source plan node IDs.
String resourceName
The name of the Amazon resource.
String outputLocation
The location in Amazon S3 where your query and calculation 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 Working
with query results, recent queries, and output files. If workgroup settings override client-side settings,
then the query uses the settings specified for the workgroup. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
EncryptionConfiguration encryptionConfiguration
If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE_KMS
or CSE_KMS
) and key information. 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.
String expectedBucketOwner
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.
AclConfiguration 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.
String outputLocation
The location in Amazon S3 where your query and calculation results are stored, such as
s3://path/to/query/bucket/
. For more information, see Working with query results, recent queries, and
output files. 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.
Boolean removeOutputLocation
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.
EncryptionConfiguration encryptionConfiguration
The encryption configuration for query and calculation results.
Boolean removeEncryptionConfiguration
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.
String expectedBucketOwner
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.
Boolean removeExpectedBucketOwner
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.
AclConfiguration aclConfiguration
The ACL configuration for the query results.
Boolean removeAclConfiguration
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.
ResultReuseByAgeConfiguration resultReuseByAgeConfiguration
Specifies whether previous query results are reused, and if so, their maximum age.
Boolean reusedPreviousResult
True if a previous query result was reused; false if the result was generated from a new run of the query.
List<E> rows
The rows in the table.
ResultSetMetadata resultSetMetadata
The metadata that describes the column structure and data types of a table of query results.
String executionRole
The ARN of the execution role used for the session.
String workingDirectory
The Amazon S3 location that stores information for the notebook.
Long idleTimeoutSeconds
The idle timeout in seconds for the session.
EncryptionConfiguration encryptionConfiguration
Long dpuExecutionInMillis
The data processing unit execution time for a session in milliseconds.
Date startDateTime
The date and time that the session started.
Date lastModifiedDateTime
The most recent date and time that the session was modified.
Date endDateTime
The date and time that the session ended.
Date idleSinceDateTime
The date and time starting at which the session became idle. Can be empty if the session is not currently idle.
String state
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.
String stateChangeReason
The reason for the session state change (for example, canceled because the session was terminated).
String sessionId
The session ID.
String description
The session description.
EngineVersion engineVersion
The engine version used by the session (for example, PySpark engine version 3
).
String notebookVersion
The notebook version.
SessionStatus status
Contains information about the session status.
String sessionId
The session ID.
String description
A description of the calculation.
CalculationConfiguration calculationConfiguration
Contains configuration information for the calculation.
String codeBlock
A string that contains the code of the calculation.
String clientRequestToken
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.
String calculationExecutionId
The calculation execution UUID.
String state
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.
String queryString
The SQL query statements to be executed.
String clientRequestToken
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.
QueryExecutionContext queryExecutionContext
The database within which the query executes.
ResultConfiguration 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.
String workGroup
The name of the workgroup in which the query is being started.
List<E> executionParameters
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.
ResultReuseConfiguration resultReuseConfiguration
Specifies the query result reuse behavior for the query.
String queryExecutionId
The unique ID of the query that ran as a result of this request.
String description
The session description.
String workGroup
The workgroup to which the session belongs.
EngineConfiguration engineConfiguration
Contains engine data processing unit (DPU) configuration settings and parameter mappings.
String notebookVersion
The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not
required for programmatic session access. The only valid notebook version is
Athena notebook version 1
. If you specify a value for NotebookVersion
, you must also
specify a value for NotebookId
. See EngineConfiguration$AdditionalConfigs.
Integer sessionIdleTimeoutInMinutes
The idle timeout in minutes for the session.
String clientRequestToken
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.
String sessionId
The session ID.
String state
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.
String calculationExecutionId
The calculation execution UUID.
String state
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.
String queryExecutionId
The unique ID of the query execution to stop.
String name
The name of the table.
Date createTime
The time that the table was created.
Date lastAccessTime
The last time the table was accessed.
String tableType
The type of table. In Athena, only EXTERNAL_TABLE
is supported.
List<E> columns
A list of the columns in the table.
List<E> partitionKeys
A list of the partition keys in the table.
Map<K,V> parameters
A set of custom key/value pairs for table properties.
String key
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.
String value
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.
String sessionId
The session ID.
String state
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.
String reason
String namedQueryId
The unique identifier of the named query.
String errorCode
The error code returned when the processing request for the named query failed, if applicable.
String errorMessage
The error message returned when the processing request for the named query failed, if applicable.
String statementName
The name of a prepared statement that could not be returned due to an error.
String errorCode
The error code returned when the request for the prepared statement failed.
String errorMessage
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.
String queryExecutionId
The unique identifier of the query execution.
String errorCode
The error code returned when the query execution failed to process, if applicable.
String errorMessage
The error message returned when the query execution failed to process, if applicable.
String name
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.
String type
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.
String description
New or modified text that describes the data catalog.
Map<K,V> parameters
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
String notebookId
The ID of the notebook to update the metadata for.
String clientRequestToken
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.
String name
The name to update the notebook to.
String notebookId
The ID of the notebook to update.
String payload
The updated content for the notebook.
String type
The notebook content type. Currently, the only valid type is IPYNB
.
String sessionId
The active notebook session ID. Required if the notebook has an active session.
String clientRequestToken
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.
String workGroup
The specified workgroup that will be updated.
String description
The workgroup description.
WorkGroupConfigurationUpdates configurationUpdates
Contains configuration updates for an Athena SQL workgroup.
String state
The workgroup state that will be updated for the given workgroup.
String name
The workgroup name.
String state
The state of the workgroup: ENABLED or DISABLED.
WorkGroupConfiguration configuration
The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results
are stored, the encryption configuration, if any, used for query and calculation 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.
String description
The workgroup description.
Date creationTime
The date and time the workgroup was created.
ResultConfiguration resultConfiguration
The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation 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 Working with query results, recent queries, and output files.
Boolean enforceWorkGroupConfiguration
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.
Boolean publishCloudWatchMetricsEnabled
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
Long bytesScannedCutoffPerQuery
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
Boolean requesterPaysEnabled
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.
EngineVersion 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.
String additionalConfiguration
Specifies a user defined JSON string that is passed to the notebook engine.
String executionRole
Role used in a session for accessing the user's resources.
CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
Boolean enableMinimumEncryptionConfiguration
Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.
The EnforceWorkGroupConfiguration
setting takes precedence over the
EnableMinimumEncryptionConfiguration
flag. This means that if
EnforceWorkGroupConfiguration
is true, the EnableMinimumEncryptionConfiguration
flag is
ignored, and the workgroup configuration for encryption is used.
Boolean enforceWorkGroupConfiguration
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.
ResultConfigurationUpdates 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.
Boolean publishCloudWatchMetricsEnabled
Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
Long bytesScannedCutoffPerQuery
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
Boolean removeBytesScannedCutoffPerQuery
Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
Boolean requesterPaysEnabled
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.
EngineVersion 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.
Boolean removeCustomerContentEncryptionConfiguration
Removes content encryption configuration for a workgroup.
String additionalConfiguration
Contains a user defined string in JSON format for a Spark-enabled workgroup.
String executionRole
Contains the ARN of the execution role for the workgroup
CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration
Boolean enableMinimumEncryptionConfiguration
Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.
The EnforceWorkGroupConfiguration
setting takes precedence over the
EnableMinimumEncryptionConfiguration
flag. This means that if
EnforceWorkGroupConfiguration
is true, the EnableMinimumEncryptionConfiguration
flag is
ignored, and the workgroup configuration for encryption is used.
String name
The name of the workgroup.
String state
The state of the workgroup.
String description
The workgroup description.
Date creationTime
The workgroup creation date and time.
EngineVersion 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.
Copyright © 2023. All rights reserved.