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 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 AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS 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 name
The workgroup name.
WorkGroupConfiguration configuration
The configuration for the 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.
String description
The workgroup description.
List<E> tags
One or more tags, separated by commas, that you want to attach to the workgroup as you create it.
String varCharValue
The value of the datum.
String namedQueryId
The unique ID of the query 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.
String namedQueryId
The unique ID of the query. Use ListNamedQueries to get query IDs.
NamedQuery namedQuery
Information about the query.
String queryExecutionId
The unique ID of the query execution.
QueryExecution queryExecution
Information about the query execution.
String workGroup
The name of the workgroup.
WorkGroup workGroup
Information about the workgroup.
String athenaErrorCode
String nextToken
The token that specifies where to start pagination if a previous request was truncated.
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.
String nextToken
The token that specifies where to start pagination if a previous request was truncated.
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.
String resourceARN
Lists the tags for the workgroup 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 workgroup resource with the specified ARN.
Integer maxResults
The maximum number of results to be returned per request that lists the tags for the workgroup resource.
String name
The query name.
String description
The query description.
String database
The database to which the query belongs.
String queryString
The SQL query statements that comprise the query.
String namedQueryId
The unique identifier of the query.
String workGroup
The name of the workgroup that contains the named query.
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 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.
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
The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.
String workGroup
The name of the workgroup in which the query ran.
String database
The name of the database.
String state
The state of query execution. QUEUED
state is listed but is not used by Athena and is reserved for
future use. RUNNING
indicates that the query has been submitted to the service, and Athena will
execute the query as soon as resources are available. 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.
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.
String resourceName
String outputLocation
The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/
.
For more information, see Queries and Query
Result 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.
EncryptionConfiguration 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.
String outputLocation
The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/
.
For more information, see Queries and Query
Result 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 the query 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.
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 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 AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS 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.
String queryExecutionId
The unique ID of the query that ran as a result of this request.
String queryExecutionId
The unique ID of the query execution to stop.
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 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 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 workGroup
The specified workgroup that will be updated.
String description
The workgroup description.
WorkGroupConfigurationUpdates configurationUpdates
The workgroup configuration that will be updated for the given 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 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 limit for the amount of data scanned per query, if it is specified. 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 results are stored and the encryption option, if any, used for query results.
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 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
Copyright © 2019. All rights reserved.