Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- ColumnNullable
- EncryptionOption
- QueryExecutionState
- ColumnInfo
- Datum
- EncryptionConfiguration
- NamedQuery
- QueryExecution
- QueryExecutionContext
- QueryExecutionStatistics
- QueryExecutionStatus
- ResultConfiguration
- ResultSet
- ResultSetMetadata
- Row
- UnprocessedNamedQueryId
- UnprocessedQueryExecutionId
- athena :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- data ColumnNullable
- data EncryptionOption
- data QueryExecutionState
- data ColumnInfo
- columnInfo :: Text -> Text -> ColumnInfo
- ciScale :: Lens' ColumnInfo (Maybe Int)
- ciPrecision :: Lens' ColumnInfo (Maybe Int)
- ciSchemaName :: Lens' ColumnInfo (Maybe Text)
- ciCatalogName :: Lens' ColumnInfo (Maybe Text)
- ciCaseSensitive :: Lens' ColumnInfo (Maybe Bool)
- ciLabel :: Lens' ColumnInfo (Maybe Text)
- ciTableName :: Lens' ColumnInfo (Maybe Text)
- ciNullable :: Lens' ColumnInfo (Maybe ColumnNullable)
- ciName :: Lens' ColumnInfo Text
- ciType :: Lens' ColumnInfo Text
- data Datum
- datum :: Datum
- dVarCharValue :: Lens' Datum (Maybe Text)
- data EncryptionConfiguration
- encryptionConfiguration :: EncryptionOption -> EncryptionConfiguration
- ecKMSKey :: Lens' EncryptionConfiguration (Maybe Text)
- ecEncryptionOption :: Lens' EncryptionConfiguration EncryptionOption
- data NamedQuery
- namedQuery :: Text -> Text -> Text -> NamedQuery
- nqNamedQueryId :: Lens' NamedQuery (Maybe Text)
- nqDescription :: Lens' NamedQuery (Maybe Text)
- nqName :: Lens' NamedQuery Text
- nqDatabase :: Lens' NamedQuery Text
- nqQueryString :: Lens' NamedQuery Text
- data QueryExecution
- queryExecution :: QueryExecution
- qeStatus :: Lens' QueryExecution (Maybe QueryExecutionStatus)
- qeQueryExecutionContext :: Lens' QueryExecution (Maybe QueryExecutionContext)
- qeResultConfiguration :: Lens' QueryExecution (Maybe ResultConfiguration)
- qeQuery :: Lens' QueryExecution (Maybe Text)
- qeStatistics :: Lens' QueryExecution (Maybe QueryExecutionStatistics)
- qeQueryExecutionId :: Lens' QueryExecution (Maybe Text)
- data QueryExecutionContext
- queryExecutionContext :: QueryExecutionContext
- qecDatabase :: Lens' QueryExecutionContext (Maybe Text)
- data QueryExecutionStatistics
- queryExecutionStatistics :: QueryExecutionStatistics
- qesEngineExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- qesDataScannedInBytes :: Lens' QueryExecutionStatistics (Maybe Integer)
- data QueryExecutionStatus
- queryExecutionStatus :: QueryExecutionStatus
- qesState :: Lens' QueryExecutionStatus (Maybe QueryExecutionState)
- qesStateChangeReason :: Lens' QueryExecutionStatus (Maybe Text)
- qesSubmissionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)
- qesCompletionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)
- data ResultConfiguration
- resultConfiguration :: Text -> ResultConfiguration
- rcEncryptionConfiguration :: Lens' ResultConfiguration (Maybe EncryptionConfiguration)
- rcOutputLocation :: Lens' ResultConfiguration Text
- data ResultSet
- resultSet :: ResultSet
- rsRows :: Lens' ResultSet [Row]
- rsResultSetMetadata :: Lens' ResultSet (Maybe ResultSetMetadata)
- data ResultSetMetadata
- resultSetMetadata :: ResultSetMetadata
- rsmColumnInfo :: Lens' ResultSetMetadata [ColumnInfo]
- data Row
- row :: Row
- rowData :: Lens' Row [Datum]
- data UnprocessedNamedQueryId
- unprocessedNamedQueryId :: UnprocessedNamedQueryId
- unqiNamedQueryId :: Lens' UnprocessedNamedQueryId (Maybe Text)
- unqiErrorCode :: Lens' UnprocessedNamedQueryId (Maybe Text)
- unqiErrorMessage :: Lens' UnprocessedNamedQueryId (Maybe Text)
- data UnprocessedQueryExecutionId
- unprocessedQueryExecutionId :: UnprocessedQueryExecutionId
- uqeiErrorCode :: Lens' UnprocessedQueryExecutionId (Maybe Text)
- uqeiQueryExecutionId :: Lens' UnprocessedQueryExecutionId (Maybe Text)
- uqeiErrorMessage :: Lens' UnprocessedQueryExecutionId (Maybe Text)
Service Configuration
Errors
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the request was throttled.
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates a platform issue, which may be due to a transient condition or outage.
ColumnNullable
data ColumnNullable Source #
EncryptionOption
data EncryptionOption Source #
QueryExecutionState
data QueryExecutionState Source #
ColumnInfo
data ColumnInfo Source #
Information about the columns in a query execution result.
See: columnInfo
smart constructor.
:: Text | |
-> Text | |
-> ColumnInfo |
Creates a value of ColumnInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ciScale
- ForDECIMAL
data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.ciPrecision
- ForDECIMAL
data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.ciSchemaName
- The schema name (database name) to which the query results belong.ciCatalogName
- The catalog to which the query results belong.ciCaseSensitive
- Indicates whether values in the column are case-sensitive.ciLabel
- A column label.ciTableName
- The table name for the query results.ciNullable
- Indicates the column's nullable status.ciName
- The name of the column.ciType
- The data type of the column.
ciScale :: Lens' ColumnInfo (Maybe Int) Source #
For DECIMAL
data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.
ciPrecision :: Lens' ColumnInfo (Maybe Int) Source #
For DECIMAL
data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.
ciSchemaName :: Lens' ColumnInfo (Maybe Text) Source #
The schema name (database name) to which the query results belong.
ciCatalogName :: Lens' ColumnInfo (Maybe Text) Source #
The catalog to which the query results belong.
ciCaseSensitive :: Lens' ColumnInfo (Maybe Bool) Source #
Indicates whether values in the column are case-sensitive.
ciTableName :: Lens' ColumnInfo (Maybe Text) Source #
The table name for the query results.
ciNullable :: Lens' ColumnInfo (Maybe ColumnNullable) Source #
Indicates the column's nullable status.
Datum
A piece of data (a field in the table).
See: datum
smart constructor.
Creates a value of Datum
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dVarCharValue
- The value of the datum.
EncryptionConfiguration
data EncryptionConfiguration Source #
If query results are encrypted in Amazon S3, indicates the Amazon S3 encryption option used.
See: encryptionConfiguration
smart constructor.
encryptionConfiguration Source #
Creates a value of EncryptionConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ecKMSKey
- ForSSE-KMS
andCSE-KMS
, this is the KMS key ARN or ID.ecEncryptionOption
- 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.
ecKMSKey :: Lens' EncryptionConfiguration (Maybe Text) Source #
For SSE-KMS
and CSE-KMS
, this is the KMS key ARN or ID.
ecEncryptionOption :: Lens' EncryptionConfiguration EncryptionOption Source #
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.
NamedQuery
data NamedQuery Source #
A query, where QueryString
is the SQL query statements that comprise the query.
See: namedQuery
smart constructor.
Creates a value of NamedQuery
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nqNamedQueryId
- The unique identifier of the query.nqDescription
- A brief description of the query.nqName
- The plain-language name of the query.nqDatabase
- The database to which the query belongs.nqQueryString
- The SQL query statements that comprise the query.
nqNamedQueryId :: Lens' NamedQuery (Maybe Text) Source #
The unique identifier of the query.
nqDescription :: Lens' NamedQuery (Maybe Text) Source #
A brief description of the query.
nqDatabase :: Lens' NamedQuery Text Source #
The database to which the query belongs.
nqQueryString :: Lens' NamedQuery Text Source #
The SQL query statements that comprise the query.
QueryExecution
data QueryExecution Source #
Information about a single instance of a query execution.
See: queryExecution
smart constructor.
queryExecution :: QueryExecution Source #
Creates a value of QueryExecution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qeStatus
- The completion date, current state, submission time, and state change reason (if applicable) for the query execution.qeQueryExecutionContext
- The database in which the query execution occurred.qeResultConfiguration
- The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results.qeQuery
- The SQL query statements which the query execution ran.qeStatistics
- The amount of data scanned during the query execution and the amount of time that it took to execute.qeQueryExecutionId
- The unique identifier for each query execution.
qeStatus :: Lens' QueryExecution (Maybe QueryExecutionStatus) Source #
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
qeQueryExecutionContext :: Lens' QueryExecution (Maybe QueryExecutionContext) Source #
The database in which the query execution occurred.
qeResultConfiguration :: Lens' QueryExecution (Maybe ResultConfiguration) Source #
The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results.
qeQuery :: Lens' QueryExecution (Maybe Text) Source #
The SQL query statements which the query execution ran.
qeStatistics :: Lens' QueryExecution (Maybe QueryExecutionStatistics) Source #
The amount of data scanned during the query execution and the amount of time that it took to execute.
qeQueryExecutionId :: Lens' QueryExecution (Maybe Text) Source #
The unique identifier for each query execution.
QueryExecutionContext
data QueryExecutionContext Source #
The database in which the query execution occurs.
See: queryExecutionContext
smart constructor.
queryExecutionContext :: QueryExecutionContext Source #
Creates a value of QueryExecutionContext
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qecDatabase
- The name of the database.
qecDatabase :: Lens' QueryExecutionContext (Maybe Text) Source #
The name of the database.
QueryExecutionStatistics
data QueryExecutionStatistics Source #
The amount of data scanned during the query execution and the amount of time that it took to execute.
See: queryExecutionStatistics
smart constructor.
queryExecutionStatistics :: QueryExecutionStatistics Source #
Creates a value of QueryExecutionStatistics
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qesEngineExecutionTimeInMillis
- The number of milliseconds that the query took to execute.qesDataScannedInBytes
- The number of bytes in the data that was queried.
qesEngineExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that the query took to execute.
qesDataScannedInBytes :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of bytes in the data that was queried.
QueryExecutionStatus
data QueryExecutionStatus Source #
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
See: queryExecutionStatus
smart constructor.
queryExecutionStatus :: QueryExecutionStatus Source #
Creates a value of QueryExecutionStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qesState
- The state of query execution.SUBMITTED
indicates that the query is queued for execution.RUNNING
indicates that the query is scanning data and returning results.SUCCEEDED
indicates that the query completed without error.FAILED
indicates that the query experienced an error and did not complete processing.CANCELLED
indicates that user input interrupted query execution.qesStateChangeReason
- Further detail about the status of the query.qesSubmissionDateTime
- The date and time that the query was submitted.qesCompletionDateTime
- The date and time that the query completed.
qesState :: Lens' QueryExecutionStatus (Maybe QueryExecutionState) Source #
The state of query execution. SUBMITTED
indicates that the query is queued for execution. RUNNING
indicates that the query is scanning data and returning results. SUCCEEDED
indicates that the query completed without error. FAILED
indicates that the query experienced an error and did not complete processing. CANCELLED
indicates that user input interrupted query execution.
qesStateChangeReason :: Lens' QueryExecutionStatus (Maybe Text) Source #
Further detail about the status of the query.
qesSubmissionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime) Source #
The date and time that the query was submitted.
qesCompletionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime) Source #
The date and time that the query completed.
ResultConfiguration
data ResultConfiguration Source #
The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.
See: resultConfiguration
smart constructor.
Creates a value of ResultConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcEncryptionConfiguration
- If query results are encrypted in S3, indicates the S3 encryption option used (for example,SSE-KMS
orCSE-KMS
and key information.rcOutputLocation
- The location in S3 where query results are stored.
rcEncryptionConfiguration :: Lens' ResultConfiguration (Maybe EncryptionConfiguration) Source #
If query results are encrypted in S3, indicates the S3 encryption option used (for example, SSE-KMS
or CSE-KMS
and key information.
rcOutputLocation :: Lens' ResultConfiguration Text Source #
The location in S3 where query results are stored.
ResultSet
The metadata and rows that comprise a query result set. The metadata describes the column structure and data types.
See: resultSet
smart constructor.
resultSet :: ResultSet Source #
Creates a value of ResultSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsRows
- The rows in the table.rsResultSetMetadata
- The metadata that describes the column structure and data types of a table of query results.
rsResultSetMetadata :: Lens' ResultSet (Maybe ResultSetMetadata) Source #
The metadata that describes the column structure and data types of a table of query results.
ResultSetMetadata
data ResultSetMetadata Source #
The metadata that describes the column structure and data types of a table of query results.
See: resultSetMetadata
smart constructor.
resultSetMetadata :: ResultSetMetadata Source #
Creates a value of ResultSetMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsmColumnInfo
- Information about the columns in a query execution result.
rsmColumnInfo :: Lens' ResultSetMetadata [ColumnInfo] Source #
Information about the columns in a query execution result.
Row
The rows that comprise a query result table.
See: row
smart constructor.
UnprocessedNamedQueryId
data UnprocessedNamedQueryId Source #
Information about a named query ID that could not be processed.
See: unprocessedNamedQueryId
smart constructor.
unprocessedNamedQueryId :: UnprocessedNamedQueryId Source #
Creates a value of UnprocessedNamedQueryId
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
unqiNamedQueryId
- The unique identifier of the named query.unqiErrorCode
- The error code returned when the processing request for the named query failed, if applicable.unqiErrorMessage
- The error message returned when the processing request for the named query failed, if applicable.
unqiNamedQueryId :: Lens' UnprocessedNamedQueryId (Maybe Text) Source #
The unique identifier of the named query.
unqiErrorCode :: Lens' UnprocessedNamedQueryId (Maybe Text) Source #
The error code returned when the processing request for the named query failed, if applicable.
unqiErrorMessage :: Lens' UnprocessedNamedQueryId (Maybe Text) Source #
The error message returned when the processing request for the named query failed, if applicable.
UnprocessedQueryExecutionId
data UnprocessedQueryExecutionId Source #
Describes a query execution that failed to process.
See: unprocessedQueryExecutionId
smart constructor.
unprocessedQueryExecutionId :: UnprocessedQueryExecutionId Source #
Creates a value of UnprocessedQueryExecutionId
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uqeiErrorCode
- The error code returned when the query execution failed to process, if applicable.uqeiQueryExecutionId
- The unique identifier of the query execution.uqeiErrorMessage
- The error message returned when the query execution failed to process, if applicable.
uqeiErrorCode :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #
The error code returned when the query execution failed to process, if applicable.
uqeiQueryExecutionId :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #
The unique identifier of the query execution.
uqeiErrorMessage :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #
The error message returned when the query execution failed to process, if applicable.