| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Athena.Types
Contents
- Service Configuration
- Errors
- CalculationExecutionState
- ColumnNullable
- DataCatalogType
- EncryptionOption
- ExecutorState
- ExecutorType
- NotebookType
- QueryExecutionState
- S3AclOption
- SessionState
- StatementType
- WorkGroupState
- AclConfiguration
- ApplicationDPUSizes
- AthenaError
- CalculationConfiguration
- CalculationResult
- CalculationStatistics
- CalculationStatus
- CalculationSummary
- Column
- ColumnInfo
- CustomerContentEncryptionConfiguration
- DataCatalog
- DataCatalogSummary
- Database
- Datum
- EncryptionConfiguration
- EngineConfiguration
- EngineVersion
- ExecutorsSummary
- FilterDefinition
- NamedQuery
- NotebookMetadata
- NotebookSessionSummary
- PreparedStatement
- PreparedStatementSummary
- QueryExecution
- QueryExecutionContext
- QueryExecutionStatistics
- QueryExecutionStatus
- QueryRuntimeStatistics
- QueryRuntimeStatisticsRows
- QueryRuntimeStatisticsTimeline
- QueryStage
- QueryStagePlanNode
- ResultConfiguration
- ResultConfigurationUpdates
- ResultReuseByAgeConfiguration
- ResultReuseConfiguration
- ResultReuseInformation
- ResultSet
- ResultSetMetadata
- Row
- SessionConfiguration
- SessionStatistics
- SessionStatus
- SessionSummary
- TableMetadata
- Tag
- UnprocessedNamedQueryId
- UnprocessedPreparedStatementName
- UnprocessedQueryExecutionId
- WorkGroup
- WorkGroupConfiguration
- WorkGroupConfigurationUpdates
- WorkGroupSummary
Description
Synopsis
- defaultService :: Service
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _MetadataException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _SessionAlreadyExistsException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- newtype CalculationExecutionState where
- CalculationExecutionState' { }
- pattern CalculationExecutionState_CANCELED :: CalculationExecutionState
- pattern CalculationExecutionState_CANCELING :: CalculationExecutionState
- pattern CalculationExecutionState_COMPLETED :: CalculationExecutionState
- pattern CalculationExecutionState_CREATED :: CalculationExecutionState
- pattern CalculationExecutionState_CREATING :: CalculationExecutionState
- pattern CalculationExecutionState_FAILED :: CalculationExecutionState
- pattern CalculationExecutionState_QUEUED :: CalculationExecutionState
- pattern CalculationExecutionState_RUNNING :: CalculationExecutionState
- newtype ColumnNullable where
- ColumnNullable' { }
- pattern ColumnNullable_NOT_NULL :: ColumnNullable
- pattern ColumnNullable_NULLABLE :: ColumnNullable
- pattern ColumnNullable_UNKNOWN :: ColumnNullable
- newtype DataCatalogType where
- DataCatalogType' { }
- pattern DataCatalogType_GLUE :: DataCatalogType
- pattern DataCatalogType_HIVE :: DataCatalogType
- pattern DataCatalogType_LAMBDA :: DataCatalogType
- newtype EncryptionOption where
- EncryptionOption' { }
- pattern EncryptionOption_CSE_KMS :: EncryptionOption
- pattern EncryptionOption_SSE_KMS :: EncryptionOption
- pattern EncryptionOption_SSE_S3 :: EncryptionOption
- newtype ExecutorState where
- ExecutorState' { }
- pattern ExecutorState_CREATED :: ExecutorState
- pattern ExecutorState_CREATING :: ExecutorState
- pattern ExecutorState_FAILED :: ExecutorState
- pattern ExecutorState_REGISTERED :: ExecutorState
- pattern ExecutorState_TERMINATED :: ExecutorState
- pattern ExecutorState_TERMINATING :: ExecutorState
- newtype ExecutorType where
- ExecutorType' { }
- pattern ExecutorType_COORDINATOR :: ExecutorType
- pattern ExecutorType_GATEWAY :: ExecutorType
- pattern ExecutorType_WORKER :: ExecutorType
- newtype NotebookType where
- NotebookType' { }
- pattern NotebookType_IPYNB :: NotebookType
- newtype QueryExecutionState where
- QueryExecutionState' { }
- pattern QueryExecutionState_CANCELLED :: QueryExecutionState
- pattern QueryExecutionState_FAILED :: QueryExecutionState
- pattern QueryExecutionState_QUEUED :: QueryExecutionState
- pattern QueryExecutionState_RUNNING :: QueryExecutionState
- pattern QueryExecutionState_SUCCEEDED :: QueryExecutionState
- newtype S3AclOption where
- S3AclOption' { }
- pattern S3AclOption_BUCKET_OWNER_FULL_CONTROL :: S3AclOption
- newtype SessionState where
- SessionState' { }
- pattern SessionState_BUSY :: SessionState
- pattern SessionState_CREATED :: SessionState
- pattern SessionState_CREATING :: SessionState
- pattern SessionState_DEGRADED :: SessionState
- pattern SessionState_FAILED :: SessionState
- pattern SessionState_IDLE :: SessionState
- pattern SessionState_TERMINATED :: SessionState
- pattern SessionState_TERMINATING :: SessionState
- newtype StatementType where
- StatementType' { }
- pattern StatementType_DDL :: StatementType
- pattern StatementType_DML :: StatementType
- pattern StatementType_UTILITY :: StatementType
- newtype WorkGroupState where
- WorkGroupState' { }
- pattern WorkGroupState_DISABLED :: WorkGroupState
- pattern WorkGroupState_ENABLED :: WorkGroupState
- data AclConfiguration = AclConfiguration' {}
- newAclConfiguration :: S3AclOption -> AclConfiguration
- aclConfiguration_s3AclOption :: Lens' AclConfiguration S3AclOption
- data ApplicationDPUSizes = ApplicationDPUSizes' {}
- newApplicationDPUSizes :: ApplicationDPUSizes
- applicationDPUSizes_applicationRuntimeId :: Lens' ApplicationDPUSizes (Maybe Text)
- applicationDPUSizes_supportedDPUSizes :: Lens' ApplicationDPUSizes (Maybe [Int])
- data AthenaError = AthenaError' {}
- newAthenaError :: AthenaError
- athenaError_errorCategory :: Lens' AthenaError (Maybe Natural)
- athenaError_errorMessage :: Lens' AthenaError (Maybe Text)
- athenaError_errorType :: Lens' AthenaError (Maybe Natural)
- athenaError_retryable :: Lens' AthenaError (Maybe Bool)
- data CalculationConfiguration = CalculationConfiguration' {}
- newCalculationConfiguration :: CalculationConfiguration
- calculationConfiguration_codeBlock :: Lens' CalculationConfiguration (Maybe Text)
- data CalculationResult = CalculationResult' {}
- newCalculationResult :: CalculationResult
- calculationResult_resultS3Uri :: Lens' CalculationResult (Maybe Text)
- calculationResult_resultType :: Lens' CalculationResult (Maybe Text)
- calculationResult_stdErrorS3Uri :: Lens' CalculationResult (Maybe Text)
- calculationResult_stdOutS3Uri :: Lens' CalculationResult (Maybe Text)
- data CalculationStatistics = CalculationStatistics' {}
- newCalculationStatistics :: CalculationStatistics
- calculationStatistics_dpuExecutionInMillis :: Lens' CalculationStatistics (Maybe Integer)
- calculationStatistics_progress :: Lens' CalculationStatistics (Maybe Text)
- data CalculationStatus = CalculationStatus' {}
- newCalculationStatus :: CalculationStatus
- calculationStatus_completionDateTime :: Lens' CalculationStatus (Maybe UTCTime)
- calculationStatus_state :: Lens' CalculationStatus (Maybe CalculationExecutionState)
- calculationStatus_stateChangeReason :: Lens' CalculationStatus (Maybe Text)
- calculationStatus_submissionDateTime :: Lens' CalculationStatus (Maybe UTCTime)
- data CalculationSummary = CalculationSummary' {}
- newCalculationSummary :: CalculationSummary
- calculationSummary_calculationExecutionId :: Lens' CalculationSummary (Maybe Text)
- calculationSummary_description :: Lens' CalculationSummary (Maybe Text)
- calculationSummary_status :: Lens' CalculationSummary (Maybe CalculationStatus)
- data Column = Column' {}
- newColumn :: Text -> Column
- column_comment :: Lens' Column (Maybe Text)
- column_type :: Lens' Column (Maybe Text)
- column_name :: Lens' Column Text
- data ColumnInfo = ColumnInfo' {}
- newColumnInfo :: Text -> Text -> ColumnInfo
- columnInfo_caseSensitive :: Lens' ColumnInfo (Maybe Bool)
- columnInfo_catalogName :: Lens' ColumnInfo (Maybe Text)
- columnInfo_label :: Lens' ColumnInfo (Maybe Text)
- columnInfo_nullable :: Lens' ColumnInfo (Maybe ColumnNullable)
- columnInfo_precision :: Lens' ColumnInfo (Maybe Int)
- columnInfo_scale :: Lens' ColumnInfo (Maybe Int)
- columnInfo_schemaName :: Lens' ColumnInfo (Maybe Text)
- columnInfo_tableName :: Lens' ColumnInfo (Maybe Text)
- columnInfo_name :: Lens' ColumnInfo Text
- columnInfo_type :: Lens' ColumnInfo Text
- data CustomerContentEncryptionConfiguration = CustomerContentEncryptionConfiguration' {}
- newCustomerContentEncryptionConfiguration :: Text -> CustomerContentEncryptionConfiguration
- customerContentEncryptionConfiguration_kmsKey :: Lens' CustomerContentEncryptionConfiguration Text
- data DataCatalog = DataCatalog' {
- description :: Maybe Text
- parameters :: Maybe (HashMap Text Text)
- name :: Text
- type' :: DataCatalogType
- newDataCatalog :: Text -> DataCatalogType -> DataCatalog
- dataCatalog_description :: Lens' DataCatalog (Maybe Text)
- dataCatalog_parameters :: Lens' DataCatalog (Maybe (HashMap Text Text))
- dataCatalog_name :: Lens' DataCatalog Text
- dataCatalog_type :: Lens' DataCatalog DataCatalogType
- data DataCatalogSummary = DataCatalogSummary' {}
- newDataCatalogSummary :: DataCatalogSummary
- dataCatalogSummary_catalogName :: Lens' DataCatalogSummary (Maybe Text)
- dataCatalogSummary_type :: Lens' DataCatalogSummary (Maybe DataCatalogType)
- data Database = Database' {
- description :: Maybe Text
- parameters :: Maybe (HashMap Text Text)
- name :: Text
- newDatabase :: Text -> Database
- database_description :: Lens' Database (Maybe Text)
- database_parameters :: Lens' Database (Maybe (HashMap Text Text))
- database_name :: Lens' Database Text
- data Datum = Datum' {}
- newDatum :: Datum
- datum_varCharValue :: Lens' Datum (Maybe Text)
- data EncryptionConfiguration = EncryptionConfiguration' {}
- newEncryptionConfiguration :: EncryptionOption -> EncryptionConfiguration
- encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration (Maybe Text)
- encryptionConfiguration_encryptionOption :: Lens' EncryptionConfiguration EncryptionOption
- data EngineConfiguration = EngineConfiguration' {}
- newEngineConfiguration :: Natural -> EngineConfiguration
- engineConfiguration_additionalConfigs :: Lens' EngineConfiguration (Maybe (HashMap Text Text))
- engineConfiguration_coordinatorDpuSize :: Lens' EngineConfiguration (Maybe Natural)
- engineConfiguration_defaultExecutorDpuSize :: Lens' EngineConfiguration (Maybe Natural)
- engineConfiguration_maxConcurrentDpus :: Lens' EngineConfiguration Natural
- data EngineVersion = EngineVersion' {}
- newEngineVersion :: EngineVersion
- engineVersion_effectiveEngineVersion :: Lens' EngineVersion (Maybe Text)
- engineVersion_selectedEngineVersion :: Lens' EngineVersion (Maybe Text)
- data ExecutorsSummary = ExecutorsSummary' {}
- newExecutorsSummary :: Text -> ExecutorsSummary
- executorsSummary_executorSize :: Lens' ExecutorsSummary (Maybe Integer)
- executorsSummary_executorState :: Lens' ExecutorsSummary (Maybe ExecutorState)
- executorsSummary_executorType :: Lens' ExecutorsSummary (Maybe ExecutorType)
- executorsSummary_startDateTime :: Lens' ExecutorsSummary (Maybe Integer)
- executorsSummary_terminationDateTime :: Lens' ExecutorsSummary (Maybe Integer)
- executorsSummary_executorId :: Lens' ExecutorsSummary Text
- data FilterDefinition = FilterDefinition' {}
- newFilterDefinition :: FilterDefinition
- filterDefinition_name :: Lens' FilterDefinition (Maybe Text)
- data NamedQuery = NamedQuery' {
- description :: Maybe Text
- namedQueryId :: Maybe Text
- workGroup :: Maybe Text
- name :: Text
- database :: Text
- queryString :: Text
- newNamedQuery :: Text -> Text -> Text -> NamedQuery
- namedQuery_description :: Lens' NamedQuery (Maybe Text)
- namedQuery_namedQueryId :: Lens' NamedQuery (Maybe Text)
- namedQuery_workGroup :: Lens' NamedQuery (Maybe Text)
- namedQuery_name :: Lens' NamedQuery Text
- namedQuery_database :: Lens' NamedQuery Text
- namedQuery_queryString :: Lens' NamedQuery Text
- data NotebookMetadata = NotebookMetadata' {
- creationTime :: Maybe POSIX
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- notebookId :: Maybe Text
- type' :: Maybe NotebookType
- workGroup :: Maybe Text
- newNotebookMetadata :: NotebookMetadata
- notebookMetadata_creationTime :: Lens' NotebookMetadata (Maybe UTCTime)
- notebookMetadata_lastModifiedTime :: Lens' NotebookMetadata (Maybe UTCTime)
- notebookMetadata_name :: Lens' NotebookMetadata (Maybe Text)
- notebookMetadata_notebookId :: Lens' NotebookMetadata (Maybe Text)
- notebookMetadata_type :: Lens' NotebookMetadata (Maybe NotebookType)
- notebookMetadata_workGroup :: Lens' NotebookMetadata (Maybe Text)
- data NotebookSessionSummary = NotebookSessionSummary' {}
- newNotebookSessionSummary :: NotebookSessionSummary
- notebookSessionSummary_creationTime :: Lens' NotebookSessionSummary (Maybe UTCTime)
- notebookSessionSummary_sessionId :: Lens' NotebookSessionSummary (Maybe Text)
- data PreparedStatement = PreparedStatement' {}
- newPreparedStatement :: PreparedStatement
- preparedStatement_description :: Lens' PreparedStatement (Maybe Text)
- preparedStatement_lastModifiedTime :: Lens' PreparedStatement (Maybe UTCTime)
- preparedStatement_queryStatement :: Lens' PreparedStatement (Maybe Text)
- preparedStatement_statementName :: Lens' PreparedStatement (Maybe Text)
- preparedStatement_workGroupName :: Lens' PreparedStatement (Maybe Text)
- data PreparedStatementSummary = PreparedStatementSummary' {}
- newPreparedStatementSummary :: PreparedStatementSummary
- preparedStatementSummary_lastModifiedTime :: Lens' PreparedStatementSummary (Maybe UTCTime)
- preparedStatementSummary_statementName :: Lens' PreparedStatementSummary (Maybe Text)
- data QueryExecution = QueryExecution' {
- engineVersion :: Maybe EngineVersion
- executionParameters :: Maybe (NonEmpty Text)
- query :: Maybe Text
- queryExecutionContext :: Maybe QueryExecutionContext
- queryExecutionId :: Maybe Text
- resultConfiguration :: Maybe ResultConfiguration
- resultReuseConfiguration :: Maybe ResultReuseConfiguration
- statementType :: Maybe StatementType
- statistics :: Maybe QueryExecutionStatistics
- status :: Maybe QueryExecutionStatus
- workGroup :: Maybe Text
- newQueryExecution :: QueryExecution
- queryExecution_engineVersion :: Lens' QueryExecution (Maybe EngineVersion)
- queryExecution_executionParameters :: Lens' QueryExecution (Maybe (NonEmpty Text))
- queryExecution_query :: Lens' QueryExecution (Maybe Text)
- queryExecution_queryExecutionContext :: Lens' QueryExecution (Maybe QueryExecutionContext)
- queryExecution_queryExecutionId :: Lens' QueryExecution (Maybe Text)
- queryExecution_resultConfiguration :: Lens' QueryExecution (Maybe ResultConfiguration)
- queryExecution_resultReuseConfiguration :: Lens' QueryExecution (Maybe ResultReuseConfiguration)
- queryExecution_statementType :: Lens' QueryExecution (Maybe StatementType)
- queryExecution_statistics :: Lens' QueryExecution (Maybe QueryExecutionStatistics)
- queryExecution_status :: Lens' QueryExecution (Maybe QueryExecutionStatus)
- queryExecution_workGroup :: Lens' QueryExecution (Maybe Text)
- data QueryExecutionContext = QueryExecutionContext' {}
- newQueryExecutionContext :: QueryExecutionContext
- queryExecutionContext_catalog :: Lens' QueryExecutionContext (Maybe Text)
- queryExecutionContext_database :: Lens' QueryExecutionContext (Maybe Text)
- data QueryExecutionStatistics = QueryExecutionStatistics' {
- dataManifestLocation :: Maybe Text
- dataScannedInBytes :: Maybe Integer
- engineExecutionTimeInMillis :: Maybe Integer
- queryPlanningTimeInMillis :: Maybe Integer
- queryQueueTimeInMillis :: Maybe Integer
- resultReuseInformation :: Maybe ResultReuseInformation
- serviceProcessingTimeInMillis :: Maybe Integer
- totalExecutionTimeInMillis :: Maybe Integer
- newQueryExecutionStatistics :: QueryExecutionStatistics
- queryExecutionStatistics_dataManifestLocation :: Lens' QueryExecutionStatistics (Maybe Text)
- queryExecutionStatistics_dataScannedInBytes :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_engineExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_queryPlanningTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_queryQueueTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_resultReuseInformation :: Lens' QueryExecutionStatistics (Maybe ResultReuseInformation)
- queryExecutionStatistics_serviceProcessingTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_totalExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- data QueryExecutionStatus = QueryExecutionStatus' {}
- newQueryExecutionStatus :: QueryExecutionStatus
- queryExecutionStatus_athenaError :: Lens' QueryExecutionStatus (Maybe AthenaError)
- queryExecutionStatus_completionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)
- queryExecutionStatus_state :: Lens' QueryExecutionStatus (Maybe QueryExecutionState)
- queryExecutionStatus_stateChangeReason :: Lens' QueryExecutionStatus (Maybe Text)
- queryExecutionStatus_submissionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)
- data QueryRuntimeStatistics = QueryRuntimeStatistics' {}
- newQueryRuntimeStatistics :: QueryRuntimeStatistics
- queryRuntimeStatistics_outputStage :: Lens' QueryRuntimeStatistics (Maybe QueryStage)
- queryRuntimeStatistics_rows :: Lens' QueryRuntimeStatistics (Maybe QueryRuntimeStatisticsRows)
- queryRuntimeStatistics_timeline :: Lens' QueryRuntimeStatistics (Maybe QueryRuntimeStatisticsTimeline)
- data QueryRuntimeStatisticsRows = QueryRuntimeStatisticsRows' {}
- newQueryRuntimeStatisticsRows :: QueryRuntimeStatisticsRows
- queryRuntimeStatisticsRows_inputBytes :: Lens' QueryRuntimeStatisticsRows (Maybe Integer)
- queryRuntimeStatisticsRows_inputRows :: Lens' QueryRuntimeStatisticsRows (Maybe Integer)
- queryRuntimeStatisticsRows_outputBytes :: Lens' QueryRuntimeStatisticsRows (Maybe Integer)
- queryRuntimeStatisticsRows_outputRows :: Lens' QueryRuntimeStatisticsRows (Maybe Integer)
- data QueryRuntimeStatisticsTimeline = QueryRuntimeStatisticsTimeline' {}
- newQueryRuntimeStatisticsTimeline :: QueryRuntimeStatisticsTimeline
- queryRuntimeStatisticsTimeline_engineExecutionTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)
- queryRuntimeStatisticsTimeline_queryPlanningTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)
- queryRuntimeStatisticsTimeline_queryQueueTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)
- queryRuntimeStatisticsTimeline_serviceProcessingTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)
- queryRuntimeStatisticsTimeline_totalExecutionTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer)
- data QueryStage = QueryStage' {}
- newQueryStage :: QueryStage
- queryStage_executionTime :: Lens' QueryStage (Maybe Integer)
- queryStage_inputBytes :: Lens' QueryStage (Maybe Integer)
- queryStage_inputRows :: Lens' QueryStage (Maybe Integer)
- queryStage_outputBytes :: Lens' QueryStage (Maybe Integer)
- queryStage_outputRows :: Lens' QueryStage (Maybe Integer)
- queryStage_queryStagePlan :: Lens' QueryStage (Maybe QueryStagePlanNode)
- queryStage_stageId :: Lens' QueryStage (Maybe Integer)
- queryStage_state :: Lens' QueryStage (Maybe Text)
- queryStage_subStages :: Lens' QueryStage (Maybe [QueryStage])
- data QueryStagePlanNode = QueryStagePlanNode' {
- children :: Maybe [QueryStagePlanNode]
- identifier :: Maybe Text
- name :: Maybe Text
- remoteSources :: Maybe [Text]
- newQueryStagePlanNode :: QueryStagePlanNode
- queryStagePlanNode_children :: Lens' QueryStagePlanNode (Maybe [QueryStagePlanNode])
- queryStagePlanNode_identifier :: Lens' QueryStagePlanNode (Maybe Text)
- queryStagePlanNode_name :: Lens' QueryStagePlanNode (Maybe Text)
- queryStagePlanNode_remoteSources :: Lens' QueryStagePlanNode (Maybe [Text])
- data ResultConfiguration = ResultConfiguration' {}
- newResultConfiguration :: ResultConfiguration
- resultConfiguration_aclConfiguration :: Lens' ResultConfiguration (Maybe AclConfiguration)
- resultConfiguration_encryptionConfiguration :: Lens' ResultConfiguration (Maybe EncryptionConfiguration)
- resultConfiguration_expectedBucketOwner :: Lens' ResultConfiguration (Maybe Text)
- resultConfiguration_outputLocation :: Lens' ResultConfiguration (Maybe Text)
- data ResultConfigurationUpdates = ResultConfigurationUpdates' {
- aclConfiguration :: Maybe AclConfiguration
- encryptionConfiguration :: Maybe EncryptionConfiguration
- expectedBucketOwner :: Maybe Text
- outputLocation :: Maybe Text
- removeAclConfiguration :: Maybe Bool
- removeEncryptionConfiguration :: Maybe Bool
- removeExpectedBucketOwner :: Maybe Bool
- removeOutputLocation :: Maybe Bool
- newResultConfigurationUpdates :: ResultConfigurationUpdates
- resultConfigurationUpdates_aclConfiguration :: Lens' ResultConfigurationUpdates (Maybe AclConfiguration)
- resultConfigurationUpdates_encryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe EncryptionConfiguration)
- resultConfigurationUpdates_expectedBucketOwner :: Lens' ResultConfigurationUpdates (Maybe Text)
- resultConfigurationUpdates_outputLocation :: Lens' ResultConfigurationUpdates (Maybe Text)
- resultConfigurationUpdates_removeAclConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool)
- resultConfigurationUpdates_removeEncryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool)
- resultConfigurationUpdates_removeExpectedBucketOwner :: Lens' ResultConfigurationUpdates (Maybe Bool)
- resultConfigurationUpdates_removeOutputLocation :: Lens' ResultConfigurationUpdates (Maybe Bool)
- data ResultReuseByAgeConfiguration = ResultReuseByAgeConfiguration' {}
- newResultReuseByAgeConfiguration :: Bool -> ResultReuseByAgeConfiguration
- resultReuseByAgeConfiguration_maxAgeInMinutes :: Lens' ResultReuseByAgeConfiguration (Maybe Natural)
- resultReuseByAgeConfiguration_enabled :: Lens' ResultReuseByAgeConfiguration Bool
- data ResultReuseConfiguration = ResultReuseConfiguration' {}
- newResultReuseConfiguration :: ResultReuseConfiguration
- resultReuseConfiguration_resultReuseByAgeConfiguration :: Lens' ResultReuseConfiguration (Maybe ResultReuseByAgeConfiguration)
- data ResultReuseInformation = ResultReuseInformation' {}
- newResultReuseInformation :: Bool -> ResultReuseInformation
- resultReuseInformation_reusedPreviousResult :: Lens' ResultReuseInformation Bool
- data ResultSet = ResultSet' {}
- newResultSet :: ResultSet
- resultSet_resultSetMetadata :: Lens' ResultSet (Maybe ResultSetMetadata)
- resultSet_rows :: Lens' ResultSet (Maybe [Row])
- data ResultSetMetadata = ResultSetMetadata' {
- columnInfo :: Maybe [ColumnInfo]
- newResultSetMetadata :: ResultSetMetadata
- resultSetMetadata_columnInfo :: Lens' ResultSetMetadata (Maybe [ColumnInfo])
- data Row = Row' {}
- newRow :: Row
- row_data :: Lens' Row (Maybe [Datum])
- data SessionConfiguration = SessionConfiguration' {}
- newSessionConfiguration :: SessionConfiguration
- sessionConfiguration_encryptionConfiguration :: Lens' SessionConfiguration (Maybe EncryptionConfiguration)
- sessionConfiguration_executionRole :: Lens' SessionConfiguration (Maybe Text)
- sessionConfiguration_idleTimeoutSeconds :: Lens' SessionConfiguration (Maybe Integer)
- sessionConfiguration_workingDirectory :: Lens' SessionConfiguration (Maybe Text)
- data SessionStatistics = SessionStatistics' {}
- newSessionStatistics :: SessionStatistics
- sessionStatistics_dpuExecutionInMillis :: Lens' SessionStatistics (Maybe Integer)
- data SessionStatus = SessionStatus' {}
- newSessionStatus :: SessionStatus
- sessionStatus_endDateTime :: Lens' SessionStatus (Maybe UTCTime)
- sessionStatus_idleSinceDateTime :: Lens' SessionStatus (Maybe UTCTime)
- sessionStatus_lastModifiedDateTime :: Lens' SessionStatus (Maybe UTCTime)
- sessionStatus_startDateTime :: Lens' SessionStatus (Maybe UTCTime)
- sessionStatus_state :: Lens' SessionStatus (Maybe SessionState)
- sessionStatus_stateChangeReason :: Lens' SessionStatus (Maybe Text)
- data SessionSummary = SessionSummary' {}
- newSessionSummary :: SessionSummary
- sessionSummary_description :: Lens' SessionSummary (Maybe Text)
- sessionSummary_engineVersion :: Lens' SessionSummary (Maybe EngineVersion)
- sessionSummary_notebookVersion :: Lens' SessionSummary (Maybe Text)
- sessionSummary_sessionId :: Lens' SessionSummary (Maybe Text)
- sessionSummary_status :: Lens' SessionSummary (Maybe SessionStatus)
- data TableMetadata = TableMetadata' {}
- newTableMetadata :: Text -> TableMetadata
- tableMetadata_columns :: Lens' TableMetadata (Maybe [Column])
- tableMetadata_createTime :: Lens' TableMetadata (Maybe UTCTime)
- tableMetadata_lastAccessTime :: Lens' TableMetadata (Maybe UTCTime)
- tableMetadata_parameters :: Lens' TableMetadata (Maybe (HashMap Text Text))
- tableMetadata_partitionKeys :: Lens' TableMetadata (Maybe [Column])
- tableMetadata_tableType :: Lens' TableMetadata (Maybe Text)
- tableMetadata_name :: Lens' TableMetadata Text
- data Tag = Tag' {}
- newTag :: Tag
- tag_key :: Lens' Tag (Maybe Text)
- tag_value :: Lens' Tag (Maybe Text)
- data UnprocessedNamedQueryId = UnprocessedNamedQueryId' {
- errorCode :: Maybe Text
- errorMessage :: Maybe Text
- namedQueryId :: Maybe Text
- newUnprocessedNamedQueryId :: UnprocessedNamedQueryId
- unprocessedNamedQueryId_errorCode :: Lens' UnprocessedNamedQueryId (Maybe Text)
- unprocessedNamedQueryId_errorMessage :: Lens' UnprocessedNamedQueryId (Maybe Text)
- unprocessedNamedQueryId_namedQueryId :: Lens' UnprocessedNamedQueryId (Maybe Text)
- data UnprocessedPreparedStatementName = UnprocessedPreparedStatementName' {}
- newUnprocessedPreparedStatementName :: UnprocessedPreparedStatementName
- unprocessedPreparedStatementName_errorCode :: Lens' UnprocessedPreparedStatementName (Maybe Text)
- unprocessedPreparedStatementName_errorMessage :: Lens' UnprocessedPreparedStatementName (Maybe Text)
- unprocessedPreparedStatementName_statementName :: Lens' UnprocessedPreparedStatementName (Maybe Text)
- data UnprocessedQueryExecutionId = UnprocessedQueryExecutionId' {}
- newUnprocessedQueryExecutionId :: UnprocessedQueryExecutionId
- unprocessedQueryExecutionId_errorCode :: Lens' UnprocessedQueryExecutionId (Maybe Text)
- unprocessedQueryExecutionId_errorMessage :: Lens' UnprocessedQueryExecutionId (Maybe Text)
- unprocessedQueryExecutionId_queryExecutionId :: Lens' UnprocessedQueryExecutionId (Maybe Text)
- data WorkGroup = WorkGroup' {}
- newWorkGroup :: Text -> WorkGroup
- workGroup_configuration :: Lens' WorkGroup (Maybe WorkGroupConfiguration)
- workGroup_creationTime :: Lens' WorkGroup (Maybe UTCTime)
- workGroup_description :: Lens' WorkGroup (Maybe Text)
- workGroup_state :: Lens' WorkGroup (Maybe WorkGroupState)
- workGroup_name :: Lens' WorkGroup Text
- data WorkGroupConfiguration = WorkGroupConfiguration' {
- additionalConfiguration :: Maybe Text
- bytesScannedCutoffPerQuery :: Maybe Natural
- customerContentEncryptionConfiguration :: Maybe CustomerContentEncryptionConfiguration
- enforceWorkGroupConfiguration :: Maybe Bool
- engineVersion :: Maybe EngineVersion
- executionRole :: Maybe Text
- publishCloudWatchMetricsEnabled :: Maybe Bool
- requesterPaysEnabled :: Maybe Bool
- resultConfiguration :: Maybe ResultConfiguration
- newWorkGroupConfiguration :: WorkGroupConfiguration
- workGroupConfiguration_additionalConfiguration :: Lens' WorkGroupConfiguration (Maybe Text)
- workGroupConfiguration_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfiguration (Maybe Natural)
- workGroupConfiguration_customerContentEncryptionConfiguration :: Lens' WorkGroupConfiguration (Maybe CustomerContentEncryptionConfiguration)
- workGroupConfiguration_enforceWorkGroupConfiguration :: Lens' WorkGroupConfiguration (Maybe Bool)
- workGroupConfiguration_engineVersion :: Lens' WorkGroupConfiguration (Maybe EngineVersion)
- workGroupConfiguration_executionRole :: Lens' WorkGroupConfiguration (Maybe Text)
- workGroupConfiguration_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfiguration (Maybe Bool)
- workGroupConfiguration_requesterPaysEnabled :: Lens' WorkGroupConfiguration (Maybe Bool)
- workGroupConfiguration_resultConfiguration :: Lens' WorkGroupConfiguration (Maybe ResultConfiguration)
- data WorkGroupConfigurationUpdates = WorkGroupConfigurationUpdates' {
- additionalConfiguration :: Maybe Text
- bytesScannedCutoffPerQuery :: Maybe Natural
- customerContentEncryptionConfiguration :: Maybe CustomerContentEncryptionConfiguration
- enforceWorkGroupConfiguration :: Maybe Bool
- engineVersion :: Maybe EngineVersion
- executionRole :: Maybe Text
- publishCloudWatchMetricsEnabled :: Maybe Bool
- removeBytesScannedCutoffPerQuery :: Maybe Bool
- removeCustomerContentEncryptionConfiguration :: Maybe Bool
- requesterPaysEnabled :: Maybe Bool
- resultConfigurationUpdates :: Maybe ResultConfigurationUpdates
- newWorkGroupConfigurationUpdates :: WorkGroupConfigurationUpdates
- workGroupConfigurationUpdates_additionalConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Text)
- workGroupConfigurationUpdates_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Natural)
- workGroupConfigurationUpdates_customerContentEncryptionConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe CustomerContentEncryptionConfiguration)
- workGroupConfigurationUpdates_enforceWorkGroupConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)
- workGroupConfigurationUpdates_engineVersion :: Lens' WorkGroupConfigurationUpdates (Maybe EngineVersion)
- workGroupConfigurationUpdates_executionRole :: Lens' WorkGroupConfigurationUpdates (Maybe Text)
- workGroupConfigurationUpdates_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)
- workGroupConfigurationUpdates_removeBytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)
- workGroupConfigurationUpdates_removeCustomerContentEncryptionConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)
- workGroupConfigurationUpdates_requesterPaysEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)
- workGroupConfigurationUpdates_resultConfigurationUpdates :: Lens' WorkGroupConfigurationUpdates (Maybe ResultConfigurationUpdates)
- data WorkGroupSummary = WorkGroupSummary' {}
- newWorkGroupSummary :: WorkGroupSummary
- workGroupSummary_creationTime :: Lens' WorkGroupSummary (Maybe UTCTime)
- workGroupSummary_description :: Lens' WorkGroupSummary (Maybe Text)
- workGroupSummary_engineVersion :: Lens' WorkGroupSummary (Maybe EngineVersion)
- workGroupSummary_name :: Lens' WorkGroupSummary (Maybe Text)
- workGroupSummary_state :: Lens' WorkGroupSummary (Maybe WorkGroupState)
Service Configuration
defaultService :: Service Source #
API version 2017-05-18 of the Amazon Athena SDK configuration.
Errors
_InternalServerException :: AsError a => Fold a ServiceError Source #
Indicates a platform issue, which may be due to a transient condition or outage.
_InvalidRequestException :: AsError a => Fold 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.
_MetadataException :: AsError a => Fold a ServiceError Source #
An exception that Athena received when it called a custom metastore.
Occurs if the error is not caused by user input
(InvalidRequestException) or from the Athena platform
(InternalServerException). For example, if a user-created Lambda
function is missing permissions, the Lambda 4XX exception is returned
in a MetadataException.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A resource, such as a workgroup, was not found.
_SessionAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified session already exists.
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
Indicates that the request was throttled.
CalculationExecutionState
newtype CalculationExecutionState Source #
Constructors
| CalculationExecutionState' | |
Fields | |
Bundled Patterns
Instances
ColumnNullable
newtype ColumnNullable Source #
Constructors
| ColumnNullable' | |
Fields | |
Bundled Patterns
| pattern ColumnNullable_NOT_NULL :: ColumnNullable | |
| pattern ColumnNullable_NULLABLE :: ColumnNullable | |
| pattern ColumnNullable_UNKNOWN :: ColumnNullable |
Instances
DataCatalogType
newtype DataCatalogType Source #
Constructors
| DataCatalogType' | |
Fields | |
Bundled Patterns
| pattern DataCatalogType_GLUE :: DataCatalogType | |
| pattern DataCatalogType_HIVE :: DataCatalogType | |
| pattern DataCatalogType_LAMBDA :: DataCatalogType |
Instances
EncryptionOption
newtype EncryptionOption Source #
Constructors
| EncryptionOption' | |
Fields | |
Bundled Patterns
| pattern EncryptionOption_CSE_KMS :: EncryptionOption | |
| pattern EncryptionOption_SSE_KMS :: EncryptionOption | |
| pattern EncryptionOption_SSE_S3 :: EncryptionOption |
Instances
ExecutorState
newtype ExecutorState Source #
Constructors
| ExecutorState' | |
Fields | |
Bundled Patterns
| pattern ExecutorState_CREATED :: ExecutorState | |
| pattern ExecutorState_CREATING :: ExecutorState | |
| pattern ExecutorState_FAILED :: ExecutorState | |
| pattern ExecutorState_REGISTERED :: ExecutorState | |
| pattern ExecutorState_TERMINATED :: ExecutorState | |
| pattern ExecutorState_TERMINATING :: ExecutorState |
Instances
ExecutorType
newtype ExecutorType Source #
Constructors
| ExecutorType' | |
Fields | |
Bundled Patterns
| pattern ExecutorType_COORDINATOR :: ExecutorType | |
| pattern ExecutorType_GATEWAY :: ExecutorType | |
| pattern ExecutorType_WORKER :: ExecutorType |
Instances
NotebookType
newtype NotebookType Source #
Constructors
| NotebookType' | |
Fields | |
Bundled Patterns
| pattern NotebookType_IPYNB :: NotebookType |
Instances
QueryExecutionState
newtype QueryExecutionState Source #
Constructors
| QueryExecutionState' | |
Fields | |
Bundled Patterns
| pattern QueryExecutionState_CANCELLED :: QueryExecutionState | |
| pattern QueryExecutionState_FAILED :: QueryExecutionState | |
| pattern QueryExecutionState_QUEUED :: QueryExecutionState | |
| pattern QueryExecutionState_RUNNING :: QueryExecutionState | |
| pattern QueryExecutionState_SUCCEEDED :: QueryExecutionState |
Instances
S3AclOption
newtype S3AclOption Source #
Constructors
| S3AclOption' | |
Fields | |
Bundled Patterns
| pattern S3AclOption_BUCKET_OWNER_FULL_CONTROL :: S3AclOption |
Instances
SessionState
newtype SessionState Source #
Constructors
| SessionState' | |
Fields | |
Bundled Patterns
| pattern SessionState_BUSY :: SessionState | |
| pattern SessionState_CREATED :: SessionState | |
| pattern SessionState_CREATING :: SessionState | |
| pattern SessionState_DEGRADED :: SessionState | |
| pattern SessionState_FAILED :: SessionState | |
| pattern SessionState_IDLE :: SessionState | |
| pattern SessionState_TERMINATED :: SessionState | |
| pattern SessionState_TERMINATING :: SessionState |
Instances
StatementType
newtype StatementType Source #
Constructors
| StatementType' | |
Fields | |
Bundled Patterns
| pattern StatementType_DDL :: StatementType | |
| pattern StatementType_DML :: StatementType | |
| pattern StatementType_UTILITY :: StatementType |
Instances
WorkGroupState
newtype WorkGroupState Source #
Constructors
| WorkGroupState' | |
Fields | |
Bundled Patterns
| pattern WorkGroupState_DISABLED :: WorkGroupState | |
| pattern WorkGroupState_ENABLED :: WorkGroupState |
Instances
AclConfiguration
data AclConfiguration Source #
Indicates that an Amazon S3 canned ACL should be set to control
ownership of stored query results. When Athena stores query results in
Amazon S3, the canned ACL is set with the x-amz-acl request header.
For more information about S3 Object Ownership, see
Object Ownership settings
in the Amazon S3 User Guide.
See: newAclConfiguration smart constructor.
Constructors
| AclConfiguration' | |
Fields
| |
Instances
Create a value of AclConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3AclOption:AclConfiguration', aclConfiguration_s3AclOption - The Amazon S3 canned ACL that Athena should specify when storing query
results. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the
workgroup overrides client-side settings, then the Amazon S3 canned ACL
specified in the workgroup's settings is used for all queries that run
in the workgroup. For more information about Amazon S3 canned ACLs, see
Canned ACL
in the Amazon S3 User Guide.
aclConfiguration_s3AclOption :: Lens' AclConfiguration S3AclOption Source #
The Amazon S3 canned ACL that Athena should specify when storing query
results. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the
workgroup overrides client-side settings, then the Amazon S3 canned ACL
specified in the workgroup's settings is used for all queries that run
in the workgroup. For more information about Amazon S3 canned ACLs, see
Canned ACL
in the Amazon S3 User Guide.
ApplicationDPUSizes
data ApplicationDPUSizes Source #
Contains the application runtime IDs and their supported DPU sizes.
See: newApplicationDPUSizes smart constructor.
Constructors
| ApplicationDPUSizes' | |
Fields
| |
Instances
newApplicationDPUSizes :: ApplicationDPUSizes Source #
Create a value of ApplicationDPUSizes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationRuntimeId:ApplicationDPUSizes', applicationDPUSizes_applicationRuntimeId - The name of the supported application runtime (for example,
Jupyter 1.0).
$sel:supportedDPUSizes:ApplicationDPUSizes', applicationDPUSizes_supportedDPUSizes - A list of the supported DPU sizes that the application runtime supports.
applicationDPUSizes_applicationRuntimeId :: Lens' ApplicationDPUSizes (Maybe Text) Source #
The name of the supported application runtime (for example,
Jupyter 1.0).
applicationDPUSizes_supportedDPUSizes :: Lens' ApplicationDPUSizes (Maybe [Int]) Source #
A list of the supported DPU sizes that the application runtime supports.
AthenaError
data AthenaError Source #
Provides information about an Athena query error. The AthenaError
feature provides standardized error information to help you understand
failed queries and take steps after a query failure occurs.
AthenaError includes an ErrorCategory field that specifies whether
the cause of the failed query is due to system error, user error, or
other error.
See: newAthenaError smart constructor.
Constructors
| AthenaError' | |
Fields
| |
Instances
newAthenaError :: AthenaError Source #
Create a value of AthenaError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCategory:AthenaError', athenaError_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
$sel:errorMessage:AthenaError', athenaError_errorMessage - Contains a short description of the error that occurred.
$sel:errorType:AthenaError', athenaError_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.
$sel:retryable:AthenaError', athenaError_retryable - True if the query might succeed if resubmitted.
athenaError_errorCategory :: Lens' AthenaError (Maybe Natural) Source #
An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.
1 - System
2 - User
3 - Other
athenaError_errorMessage :: Lens' AthenaError (Maybe Text) Source #
Contains a short description of the error that occurred.
athenaError_errorType :: Lens' AthenaError (Maybe Natural) Source #
An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.
athenaError_retryable :: Lens' AthenaError (Maybe Bool) Source #
True if the query might succeed if resubmitted.
CalculationConfiguration
data CalculationConfiguration Source #
Contains configuration information for the calculation.
See: newCalculationConfiguration smart constructor.
Constructors
| CalculationConfiguration' | |
Instances
newCalculationConfiguration :: CalculationConfiguration Source #
Create a value of CalculationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeBlock:CalculationConfiguration', calculationConfiguration_codeBlock - A string that contains the code for the calculation.
calculationConfiguration_codeBlock :: Lens' CalculationConfiguration (Maybe Text) Source #
A string that contains the code for the calculation.
CalculationResult
data CalculationResult Source #
Contains information about an application-specific calculation result.
See: newCalculationResult smart constructor.
Constructors
| CalculationResult' | |
Fields
| |
Instances
newCalculationResult :: CalculationResult Source #
Create a value of CalculationResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resultS3Uri:CalculationResult', calculationResult_resultS3Uri - The Amazon S3 location of the folder for the calculation results.
$sel:resultType:CalculationResult', calculationResult_resultType - The data format of the calculation result.
$sel:stdErrorS3Uri:CalculationResult', calculationResult_stdErrorS3Uri - The Amazon S3 location of the stderr error messages file for the
calculation.
$sel:stdOutS3Uri:CalculationResult', calculationResult_stdOutS3Uri - The Amazon S3 location of the stdout file for the calculation.
calculationResult_resultS3Uri :: Lens' CalculationResult (Maybe Text) Source #
The Amazon S3 location of the folder for the calculation results.
calculationResult_resultType :: Lens' CalculationResult (Maybe Text) Source #
The data format of the calculation result.
calculationResult_stdErrorS3Uri :: Lens' CalculationResult (Maybe Text) Source #
The Amazon S3 location of the stderr error messages file for the
calculation.
calculationResult_stdOutS3Uri :: Lens' CalculationResult (Maybe Text) Source #
The Amazon S3 location of the stdout file for the calculation.
CalculationStatistics
data CalculationStatistics Source #
Contains statistics for a notebook calculation.
See: newCalculationStatistics smart constructor.
Constructors
| CalculationStatistics' | |
Instances
newCalculationStatistics :: CalculationStatistics Source #
Create a value of CalculationStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dpuExecutionInMillis:CalculationStatistics', calculationStatistics_dpuExecutionInMillis - The data processing unit execution time in milliseconds for the
calculation.
$sel:progress:CalculationStatistics', calculationStatistics_progress - The progress of the calculation.
calculationStatistics_dpuExecutionInMillis :: Lens' CalculationStatistics (Maybe Integer) Source #
The data processing unit execution time in milliseconds for the calculation.
calculationStatistics_progress :: Lens' CalculationStatistics (Maybe Text) Source #
The progress of the calculation.
CalculationStatus
data CalculationStatus Source #
Contains information about the status of a notebook calculation.
See: newCalculationStatus smart constructor.
Constructors
| CalculationStatus' | |
Fields
| |
Instances
newCalculationStatus :: CalculationStatus Source #
Create a value of CalculationStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:completionDateTime:CalculationStatus', calculationStatus_completionDateTime - The date and time the calculation completed processing.
$sel:state:CalculationStatus', calculationStatus_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.
$sel:stateChangeReason:CalculationStatus', calculationStatus_stateChangeReason - The reason for the calculation state change (for example, the
calculation was canceled because the session was terminated).
$sel:submissionDateTime:CalculationStatus', calculationStatus_submissionDateTime - The date and time the calculation was submitted for processing.
calculationStatus_completionDateTime :: Lens' CalculationStatus (Maybe UTCTime) Source #
The date and time the calculation completed processing.
calculationStatus_state :: Lens' CalculationStatus (Maybe CalculationExecutionState) Source #
The state of the calculation execution. A description of each state follows.
CREATING - The calculation is in the process of being created.
CREATED - The calculation has been created and is ready to run.
QUEUED - The calculation has been queued for processing.
RUNNING - The calculation is running.
CANCELING - A request to cancel the calculation has been received and
the system is working to stop it.
CANCELED - The calculation is no longer running as the result of a
cancel request.
COMPLETED - The calculation has completed without error.
FAILED - The calculation failed and is no longer running.
calculationStatus_stateChangeReason :: Lens' CalculationStatus (Maybe Text) Source #
The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).
calculationStatus_submissionDateTime :: Lens' CalculationStatus (Maybe UTCTime) Source #
The date and time the calculation was submitted for processing.
CalculationSummary
data CalculationSummary Source #
Summary information for a notebook calculation.
See: newCalculationSummary smart constructor.
Constructors
| CalculationSummary' | |
Fields
| |
Instances
newCalculationSummary :: CalculationSummary Source #
Create a value of CalculationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:calculationExecutionId:CalculationSummary', calculationSummary_calculationExecutionId - The calculation execution UUID.
$sel:description:CalculationSummary', calculationSummary_description - A description of the calculation.
$sel:status:CalculationSummary', calculationSummary_status - Contains information about the status of the calculation.
calculationSummary_calculationExecutionId :: Lens' CalculationSummary (Maybe Text) Source #
The calculation execution UUID.
calculationSummary_description :: Lens' CalculationSummary (Maybe Text) Source #
A description of the calculation.
calculationSummary_status :: Lens' CalculationSummary (Maybe CalculationStatus) Source #
Contains information about the status of the calculation.
Column
Contains metadata for a column in a table.
See: newColumn smart constructor.
Constructors
| Column' | |
Instances
| FromJSON Column Source # | |
| Generic Column Source # | |
| Read Column Source # | |
| Show Column Source # | |
| NFData Column Source # | |
Defined in Amazonka.Athena.Types.Column | |
| Eq Column Source # | |
| Hashable Column Source # | |
Defined in Amazonka.Athena.Types.Column | |
| type Rep Column Source # | |
Defined in Amazonka.Athena.Types.Column type Rep Column = D1 ('MetaData "Column" "Amazonka.Athena.Types.Column" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "Column'" 'PrefixI 'True) (S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Column with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comment:Column', column_comment - Optional information about the column.
$sel:type':Column', column_type - The data type of the column.
$sel:name:Column', column_name - The name of the column.
ColumnInfo
data ColumnInfo Source #
Information about the columns in a query execution result.
See: newColumnInfo smart constructor.
Constructors
| ColumnInfo' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ColumnInfo |
Create a value of ColumnInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:caseSensitive:ColumnInfo', columnInfo_caseSensitive - Indicates whether values in the column are case-sensitive.
$sel:catalogName:ColumnInfo', columnInfo_catalogName - The catalog to which the query results belong.
$sel:label:ColumnInfo', columnInfo_label - A column label.
$sel:nullable:ColumnInfo', columnInfo_nullable - Indicates the column's nullable status.
$sel:precision:ColumnInfo', columnInfo_precision - For DECIMAL data types, specifies the total number of digits, up to
38. For performance reasons, we recommend up to 18 digits.
$sel:scale:ColumnInfo', columnInfo_scale - For DECIMAL data types, specifies the total number of digits in the
fractional part of the value. Defaults to 0.
$sel:schemaName:ColumnInfo', columnInfo_schemaName - The schema name (database name) to which the query results belong.
$sel:tableName:ColumnInfo', columnInfo_tableName - The table name for the query results.
$sel:name:ColumnInfo', columnInfo_name - The name of the column.
$sel:type':ColumnInfo', columnInfo_type - The data type of the column.
columnInfo_caseSensitive :: Lens' ColumnInfo (Maybe Bool) Source #
Indicates whether values in the column are case-sensitive.
columnInfo_catalogName :: Lens' ColumnInfo (Maybe Text) Source #
The catalog to which the query results belong.
columnInfo_label :: Lens' ColumnInfo (Maybe Text) Source #
A column label.
columnInfo_nullable :: Lens' ColumnInfo (Maybe ColumnNullable) Source #
Indicates the column's nullable status.
columnInfo_precision :: 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.
columnInfo_scale :: 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.
columnInfo_schemaName :: Lens' ColumnInfo (Maybe Text) Source #
The schema name (database name) to which the query results belong.
columnInfo_tableName :: Lens' ColumnInfo (Maybe Text) Source #
The table name for the query results.
columnInfo_name :: Lens' ColumnInfo Text Source #
The name of the column.
columnInfo_type :: Lens' ColumnInfo Text Source #
The data type of the column.
CustomerContentEncryptionConfiguration
data CustomerContentEncryptionConfiguration Source #
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
See: newCustomerContentEncryptionConfiguration smart constructor.
Constructors
| CustomerContentEncryptionConfiguration' | |
Instances
newCustomerContentEncryptionConfiguration Source #
Arguments
| :: Text | |
| -> CustomerContentEncryptionConfiguration |
Create a value of CustomerContentEncryptionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:CustomerContentEncryptionConfiguration', customerContentEncryptionConfiguration_kmsKey - The KMS key that is used to encrypt the user's data stores in Athena.
customerContentEncryptionConfiguration_kmsKey :: Lens' CustomerContentEncryptionConfiguration Text Source #
The KMS key that is used to encrypt the user's data stores in Athena.
DataCatalog
data DataCatalog Source #
Contains information about a data catalog in an Amazon Web Services account.
See: newDataCatalog smart constructor.
Constructors
| DataCatalog' | |
Fields
| |
Instances
Create a value of DataCatalog with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:DataCatalog', dataCatalog_description - An optional description of the data catalog.
$sel:parameters:DataCatalog', dataCatalog_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
HIVEdata catalog type, use the following syntax. Themetadata-functionparameter is required.The sdk-versionparameter is optional and defaults to the currently supported version.metadata-function=lambda_arn, sdk-version=version_numberFor the
LAMBDAdata 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_arnIf 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
GLUEtype takes a catalog ID parameter and is required. Thecatalog_idcatalog-id=catalog_id- The
GLUEdata catalog type also applies to the defaultAwsDataCatalogthat 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
AwsDataCatalogmust be run on Athena engine version 2.
- The
$sel:name:DataCatalog', dataCatalog_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.
$sel:type':DataCatalog', dataCatalog_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.
dataCatalog_description :: Lens' DataCatalog (Maybe Text) Source #
An optional description of the data catalog.
dataCatalog_parameters :: Lens' DataCatalog (Maybe (HashMap Text Text)) Source #
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
HIVEdata catalog type, use the following syntax. Themetadata-functionparameter is required.The sdk-versionparameter is optional and defaults to the currently supported version.metadata-function=lambda_arn, sdk-version=version_numberFor the
LAMBDAdata 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_arnIf 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
GLUEtype takes a catalog ID parameter and is required. Thecatalog_idcatalog-id=catalog_id- The
GLUEdata catalog type also applies to the defaultAwsDataCatalogthat 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
AwsDataCatalogmust be run on Athena engine version 2.
- The
dataCatalog_name :: Lens' DataCatalog Text Source #
The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
dataCatalog_type :: Lens' DataCatalog DataCatalogType Source #
The type of data catalog to create: LAMBDA for a federated catalog,
HIVE for an external hive metastore, or GLUE for an Glue Data
Catalog.
DataCatalogSummary
data DataCatalogSummary Source #
The summary information for the data catalog, which includes its name and type.
See: newDataCatalogSummary smart constructor.
Constructors
| DataCatalogSummary' | |
Fields
| |
Instances
newDataCatalogSummary :: DataCatalogSummary Source #
Create a value of DataCatalogSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:catalogName:DataCatalogSummary', dataCatalogSummary_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.
$sel:type':DataCatalogSummary', dataCatalogSummary_type - The data catalog type.
dataCatalogSummary_catalogName :: Lens' DataCatalogSummary (Maybe Text) Source #
The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
dataCatalogSummary_type :: Lens' DataCatalogSummary (Maybe DataCatalogType) Source #
The data catalog type.
Database
Contains metadata information for a database in a data catalog.
See: newDatabase smart constructor.
Constructors
| Database' | |
Fields
| |
Instances
| FromJSON Database Source # | |
| Generic Database Source # | |
| Read Database Source # | |
| Show Database Source # | |
| NFData Database Source # | |
Defined in Amazonka.Athena.Types.Database | |
| Eq Database Source # | |
| Hashable Database Source # | |
Defined in Amazonka.Athena.Types.Database | |
| type Rep Database Source # | |
Defined in Amazonka.Athena.Types.Database type Rep Database = D1 ('MetaData "Database" "Amazonka.Athena.Types.Database" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "Database'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Database with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Database', database_description - An optional description of the database.
$sel:parameters:Database', database_parameters - A set of custom key/value pairs.
$sel:name:Database', database_name - The name of the database.
database_description :: Lens' Database (Maybe Text) Source #
An optional description of the database.
database_parameters :: Lens' Database (Maybe (HashMap Text Text)) Source #
A set of custom key/value pairs.
Datum
A piece of data (a field in the table).
See: newDatum smart constructor.
Constructors
| Datum' | |
Fields
| |
Instances
Create a value of Datum with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:varCharValue:Datum', datum_varCharValue - The value of the datum.
EncryptionConfiguration
data EncryptionConfiguration Source #
If query results are encrypted in Amazon S3, indicates the encryption
option used (for example, SSE_KMS or CSE_KMS) and key information.
See: newEncryptionConfiguration smart constructor.
Constructors
| EncryptionConfiguration' | |
Fields
| |
Instances
newEncryptionConfiguration Source #
Arguments
| :: EncryptionOption | |
| -> EncryptionConfiguration |
Create a value of EncryptionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:EncryptionConfiguration', encryptionConfiguration_kmsKey - For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
$sel:encryptionOption:EncryptionConfiguration', encryptionConfiguration_encryptionOption - Indicates whether Amazon S3 server-side encryption with Amazon
S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys
(SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS)
is used.
If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration (Maybe Text) Source #
For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
encryptionConfiguration_encryptionOption :: 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.
If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
EngineConfiguration
data EngineConfiguration Source #
Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.
See: newEngineConfiguration smart constructor.
Constructors
| EngineConfiguration' | |
Fields
| |
Instances
newEngineConfiguration Source #
Create a value of EngineConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalConfigs:EngineConfiguration', engineConfiguration_additionalConfigs - Contains additional notebook engine MAP<string, string> parameter
mappings in the form of key-value pairs. To specify an Amazon S3 URI
that the Jupyter server will download and serve, specify a value for the
StartSessionRequest$NotebookVersion field, and then add a key named
NotebookFileURI to AdditionalConfigs that has value of the Amazon S3
URI.
$sel:coordinatorDpuSize:EngineConfiguration', engineConfiguration_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.
$sel:defaultExecutorDpuSize:EngineConfiguration', engineConfiguration_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.
$sel:maxConcurrentDpus:EngineConfiguration', engineConfiguration_maxConcurrentDpus - The maximum number of DPUs that can run concurrently.
engineConfiguration_additionalConfigs :: Lens' EngineConfiguration (Maybe (HashMap Text Text)) Source #
Contains additional notebook engine MAP<string, string> parameter
mappings in the form of key-value pairs. To specify an Amazon S3 URI
that the Jupyter server will download and serve, specify a value for the
StartSessionRequest$NotebookVersion field, and then add a key named
NotebookFileURI to AdditionalConfigs that has value of the Amazon S3
URI.
engineConfiguration_coordinatorDpuSize :: Lens' EngineConfiguration (Maybe Natural) Source #
The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.
engineConfiguration_defaultExecutorDpuSize :: Lens' EngineConfiguration (Maybe Natural) Source #
The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.
engineConfiguration_maxConcurrentDpus :: Lens' EngineConfiguration Natural Source #
The maximum number of DPUs that can run concurrently.
EngineVersion
data EngineVersion Source #
The Athena engine version for running queries, or the PySpark engine version for running sessions.
See: newEngineVersion smart constructor.
Constructors
| EngineVersion' | |
Fields
| |
Instances
newEngineVersion :: EngineVersion Source #
Create a value of EngineVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:effectiveEngineVersion:EngineVersion', engineVersion_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.
$sel:selectedEngineVersion:EngineVersion', engineVersion_selectedEngineVersion - The engine version requested by the user. Possible values are determined
by the output of ListEngineVersions, including Auto. The default is
Auto.
engineVersion_effectiveEngineVersion :: Lens' EngineVersion (Maybe Text) Source #
Read only. The engine version on which the query runs. If the user
requests a valid engine version other than Auto, the effective engine
version is the same as the engine version that the user requested. If
the user requests Auto, the effective engine version is chosen by
Athena. When a request to update the engine version is made by a
CreateWorkGroup or UpdateWorkGroup operation, the
EffectiveEngineVersion field is ignored.
engineVersion_selectedEngineVersion :: Lens' EngineVersion (Maybe Text) Source #
The engine version requested by the user. Possible values are determined
by the output of ListEngineVersions, including Auto. The default is
Auto.
ExecutorsSummary
data ExecutorsSummary Source #
Contains summary information about an executor.
See: newExecutorsSummary smart constructor.
Constructors
| ExecutorsSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ExecutorsSummary |
Create a value of ExecutorsSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:executorSize:ExecutorsSummary', executorsSummary_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.
$sel:executorState:ExecutorsSummary', executorsSummary_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.
$sel:executorType:ExecutorsSummary', executorsSummary_executorType - The type of executor used for the application (COORDINATOR, GATEWAY,
or WORKER).
$sel:startDateTime:ExecutorsSummary', executorsSummary_startDateTime - The date and time that the executor started.
$sel:terminationDateTime:ExecutorsSummary', executorsSummary_terminationDateTime - The date and time that the executor was terminated.
$sel:executorId:ExecutorsSummary', executorsSummary_executorId - The UUID of the executor.
executorsSummary_executorSize :: Lens' ExecutorsSummary (Maybe Integer) Source #
The smallest unit of compute that a session can request from Athena. Size is measured in data processing unit (DPU) values, a relative measure of processing power.
executorsSummary_executorState :: Lens' ExecutorsSummary (Maybe ExecutorState) Source #
The processing state of the executor. A description of each state follows.
CREATING - The executor is being started, including acquiring
resources.
CREATED - The executor has been started.
REGISTERED - The executor has been registered.
TERMINATING - The executor is in the process of shutting down.
TERMINATED - The executor is no longer running.
FAILED - Due to a failure, the executor is no longer running.
executorsSummary_executorType :: Lens' ExecutorsSummary (Maybe ExecutorType) Source #
The type of executor used for the application (COORDINATOR, GATEWAY,
or WORKER).
executorsSummary_startDateTime :: Lens' ExecutorsSummary (Maybe Integer) Source #
The date and time that the executor started.
executorsSummary_terminationDateTime :: Lens' ExecutorsSummary (Maybe Integer) Source #
The date and time that the executor was terminated.
executorsSummary_executorId :: Lens' ExecutorsSummary Text Source #
The UUID of the executor.
FilterDefinition
data FilterDefinition Source #
A string for searching notebook names.
See: newFilterDefinition smart constructor.
Constructors
| FilterDefinition' | |
Instances
newFilterDefinition :: FilterDefinition Source #
Create a value of FilterDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:FilterDefinition', filterDefinition_name - The name of the notebook to search for.
filterDefinition_name :: Lens' FilterDefinition (Maybe Text) Source #
The name of the notebook to search for.
NamedQuery
data NamedQuery Source #
A query, where QueryString contains the SQL statements that make up
the query.
See: newNamedQuery smart constructor.
Constructors
| NamedQuery' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> NamedQuery |
Create a value of NamedQuery with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:NamedQuery', namedQuery_description - The query description.
$sel:namedQueryId:NamedQuery', namedQuery_namedQueryId - The unique identifier of the query.
$sel:workGroup:NamedQuery', namedQuery_workGroup - The name of the workgroup that contains the named query.
$sel:name:NamedQuery', namedQuery_name - The query name.
$sel:database:NamedQuery', namedQuery_database - The database to which the query belongs.
$sel:queryString:NamedQuery', namedQuery_queryString - The SQL statements that make up the query.
namedQuery_description :: Lens' NamedQuery (Maybe Text) Source #
The query description.
namedQuery_namedQueryId :: Lens' NamedQuery (Maybe Text) Source #
The unique identifier of the query.
namedQuery_workGroup :: Lens' NamedQuery (Maybe Text) Source #
The name of the workgroup that contains the named query.
namedQuery_name :: Lens' NamedQuery Text Source #
The query name.
namedQuery_database :: Lens' NamedQuery Text Source #
The database to which the query belongs.
namedQuery_queryString :: Lens' NamedQuery Text Source #
The SQL statements that make up the query.
NotebookMetadata
data NotebookMetadata Source #
Contains metadata for notebook, including the notebook name, ID, workgroup, and time created.
See: newNotebookMetadata smart constructor.
Constructors
| NotebookMetadata' | |
Fields
| |
Instances
newNotebookMetadata :: NotebookMetadata Source #
Create a value of NotebookMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:NotebookMetadata', notebookMetadata_creationTime - The time when the notebook was created.
$sel:lastModifiedTime:NotebookMetadata', notebookMetadata_lastModifiedTime - The time when the notebook was last modified.
$sel:name:NotebookMetadata', notebookMetadata_name - The name of the notebook.
$sel:notebookId:NotebookMetadata', notebookMetadata_notebookId - The notebook ID.
$sel:type':NotebookMetadata', notebookMetadata_type - The type of notebook. Currently, the only valid type is IPYNB.
$sel:workGroup:NotebookMetadata', notebookMetadata_workGroup - The name of the Spark enabled workgroup to which the notebook belongs.
notebookMetadata_creationTime :: Lens' NotebookMetadata (Maybe UTCTime) Source #
The time when the notebook was created.
notebookMetadata_lastModifiedTime :: Lens' NotebookMetadata (Maybe UTCTime) Source #
The time when the notebook was last modified.
notebookMetadata_name :: Lens' NotebookMetadata (Maybe Text) Source #
The name of the notebook.
notebookMetadata_notebookId :: Lens' NotebookMetadata (Maybe Text) Source #
The notebook ID.
notebookMetadata_type :: Lens' NotebookMetadata (Maybe NotebookType) Source #
The type of notebook. Currently, the only valid type is IPYNB.
notebookMetadata_workGroup :: Lens' NotebookMetadata (Maybe Text) Source #
The name of the Spark enabled workgroup to which the notebook belongs.
NotebookSessionSummary
data NotebookSessionSummary Source #
Contains the notebook session ID and notebook session creation time.
See: newNotebookSessionSummary smart constructor.
Constructors
| NotebookSessionSummary' | |
Instances
newNotebookSessionSummary :: NotebookSessionSummary Source #
Create a value of NotebookSessionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:NotebookSessionSummary', notebookSessionSummary_creationTime - The time when the notebook session was created.
$sel:sessionId:NotebookSessionSummary', notebookSessionSummary_sessionId - The notebook session ID.
notebookSessionSummary_creationTime :: Lens' NotebookSessionSummary (Maybe UTCTime) Source #
The time when the notebook session was created.
notebookSessionSummary_sessionId :: Lens' NotebookSessionSummary (Maybe Text) Source #
The notebook session ID.
PreparedStatement
data PreparedStatement Source #
A prepared SQL statement for use with Athena.
See: newPreparedStatement smart constructor.
Constructors
| PreparedStatement' | |
Fields
| |
Instances
newPreparedStatement :: PreparedStatement Source #
Create a value of PreparedStatement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:PreparedStatement', preparedStatement_description - The description of the prepared statement.
$sel:lastModifiedTime:PreparedStatement', preparedStatement_lastModifiedTime - The last modified time of the prepared statement.
$sel:queryStatement:PreparedStatement', preparedStatement_queryStatement - The query string for the prepared statement.
$sel:statementName:PreparedStatement', preparedStatement_statementName - The name of the prepared statement.
$sel:workGroupName:PreparedStatement', preparedStatement_workGroupName - The name of the workgroup to which the prepared statement belongs.
preparedStatement_description :: Lens' PreparedStatement (Maybe Text) Source #
The description of the prepared statement.
preparedStatement_lastModifiedTime :: Lens' PreparedStatement (Maybe UTCTime) Source #
The last modified time of the prepared statement.
preparedStatement_queryStatement :: Lens' PreparedStatement (Maybe Text) Source #
The query string for the prepared statement.
preparedStatement_statementName :: Lens' PreparedStatement (Maybe Text) Source #
The name of the prepared statement.
preparedStatement_workGroupName :: Lens' PreparedStatement (Maybe Text) Source #
The name of the workgroup to which the prepared statement belongs.
PreparedStatementSummary
data PreparedStatementSummary Source #
The name and last modified time of the prepared statement.
See: newPreparedStatementSummary smart constructor.
Constructors
| PreparedStatementSummary' | |
Fields
| |
Instances
newPreparedStatementSummary :: PreparedStatementSummary Source #
Create a value of PreparedStatementSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastModifiedTime:PreparedStatementSummary', preparedStatementSummary_lastModifiedTime - The last modified time of the prepared statement.
$sel:statementName:PreparedStatementSummary', preparedStatementSummary_statementName - The name of the prepared statement.
preparedStatementSummary_lastModifiedTime :: Lens' PreparedStatementSummary (Maybe UTCTime) Source #
The last modified time of the prepared statement.
preparedStatementSummary_statementName :: Lens' PreparedStatementSummary (Maybe Text) Source #
The name of the prepared statement.
QueryExecution
data QueryExecution Source #
Information about a single instance of a query execution.
See: newQueryExecution smart constructor.
Constructors
| QueryExecution' | |
Fields
| |
Instances
newQueryExecution :: QueryExecution Source #
Create a value of QueryExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineVersion:QueryExecution', queryExecution_engineVersion - The engine version that executed the query.
$sel:executionParameters:QueryExecution', queryExecution_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.
$sel:query:QueryExecution', queryExecution_query - The SQL query statements which the query execution ran.
$sel:queryExecutionContext:QueryExecution', queryExecution_queryExecutionContext - The database in which the query execution occurred.
$sel:queryExecutionId:QueryExecution', queryExecution_queryExecutionId - The unique identifier for each query execution.
$sel:resultConfiguration:QueryExecution', queryExecution_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.
$sel:resultReuseConfiguration:QueryExecution', queryExecution_resultReuseConfiguration - Specifies the query result reuse behavior that was used for the query.
$sel:statementType:QueryExecution', queryExecution_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.
$sel:statistics:QueryExecution', queryExecution_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.
$sel:status:QueryExecution', queryExecution_status - The completion date, current state, submission time, and state change
reason (if applicable) for the query execution.
$sel:workGroup:QueryExecution', queryExecution_workGroup - The name of the workgroup in which the query ran.
queryExecution_engineVersion :: Lens' QueryExecution (Maybe EngineVersion) Source #
The engine version that executed the query.
queryExecution_executionParameters :: Lens' QueryExecution (Maybe (NonEmpty Text)) Source #
A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.
queryExecution_query :: Lens' QueryExecution (Maybe Text) Source #
The SQL query statements which the query execution ran.
queryExecution_queryExecutionContext :: Lens' QueryExecution (Maybe QueryExecutionContext) Source #
The database in which the query execution occurred.
queryExecution_queryExecutionId :: Lens' QueryExecution (Maybe Text) Source #
The unique identifier for each query execution.
queryExecution_resultConfiguration :: 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. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.
queryExecution_resultReuseConfiguration :: Lens' QueryExecution (Maybe ResultReuseConfiguration) Source #
Specifies the query result reuse behavior that was used for the query.
queryExecution_statementType :: Lens' QueryExecution (Maybe StatementType) Source #
The type of query statement that was run. DDL indicates DDL query
statements. DML indicates DML (Data Manipulation Language) query
statements, such as CREATE TABLE AS SELECT. UTILITY indicates query
statements other than DDL and DML, such as SHOW CREATE TABLE, or
DESCRIBE TABLE.
queryExecution_statistics :: Lens' QueryExecution (Maybe QueryExecutionStatistics) Source #
Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.
queryExecution_status :: Lens' QueryExecution (Maybe QueryExecutionStatus) Source #
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
queryExecution_workGroup :: Lens' QueryExecution (Maybe Text) Source #
The name of the workgroup in which the query ran.
QueryExecutionContext
data QueryExecutionContext Source #
The database and data catalog context in which the query execution occurs.
See: newQueryExecutionContext smart constructor.
Constructors
| QueryExecutionContext' | |
Instances
newQueryExecutionContext :: QueryExecutionContext Source #
Create a value of QueryExecutionContext with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:catalog:QueryExecutionContext', queryExecutionContext_catalog - The name of the data catalog used in the query execution.
$sel:database:QueryExecutionContext', queryExecutionContext_database - The name of the database used in the query execution. The database must
exist in the catalog.
queryExecutionContext_catalog :: Lens' QueryExecutionContext (Maybe Text) Source #
The name of the data catalog used in the query execution.
queryExecutionContext_database :: Lens' QueryExecutionContext (Maybe Text) Source #
The name of the database used in the query execution. The database must exist in the catalog.
QueryExecutionStatistics
data QueryExecutionStatistics Source #
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.
See: newQueryExecutionStatistics smart constructor.
Constructors
| QueryExecutionStatistics' | |
Fields
| |
Instances
newQueryExecutionStatistics :: QueryExecutionStatistics Source #
Create a value of QueryExecutionStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataManifestLocation:QueryExecutionStatistics', queryExecutionStatistics_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.
$sel:dataScannedInBytes:QueryExecutionStatistics', queryExecutionStatistics_dataScannedInBytes - The number of bytes in the data that was queried.
$sel:engineExecutionTimeInMillis:QueryExecutionStatistics', queryExecutionStatistics_engineExecutionTimeInMillis - The number of milliseconds that the query took to execute.
$sel:queryPlanningTimeInMillis:QueryExecutionStatistics', queryExecutionStatistics_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.
$sel:queryQueueTimeInMillis:QueryExecutionStatistics', queryExecutionStatistics_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.
$sel:resultReuseInformation:QueryExecutionStatistics', queryExecutionStatistics_resultReuseInformation - Contains information about whether previous query results were reused
for the query.
$sel:serviceProcessingTimeInMillis:QueryExecutionStatistics', queryExecutionStatistics_serviceProcessingTimeInMillis - The number of milliseconds that Athena took to finalize and publish the
query results after the query engine finished running the query.
$sel:totalExecutionTimeInMillis:QueryExecutionStatistics', queryExecutionStatistics_totalExecutionTimeInMillis - The number of milliseconds that Athena took to run the query.
queryExecutionStatistics_dataManifestLocation :: Lens' QueryExecutionStatistics (Maybe Text) Source #
The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.
queryExecutionStatistics_dataScannedInBytes :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of bytes in the data that was queried.
queryExecutionStatistics_engineExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that the query took to execute.
queryExecutionStatistics_queryPlanningTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.
queryExecutionStatistics_queryQueueTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.
queryExecutionStatistics_resultReuseInformation :: Lens' QueryExecutionStatistics (Maybe ResultReuseInformation) Source #
Contains information about whether previous query results were reused for the query.
queryExecutionStatistics_serviceProcessingTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
queryExecutionStatistics_totalExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that Athena took to run the query.
QueryExecutionStatus
data QueryExecutionStatus Source #
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
See: newQueryExecutionStatus smart constructor.
Constructors
| QueryExecutionStatus' | |
Fields
| |
Instances
newQueryExecutionStatus :: QueryExecutionStatus Source #
Create a value of QueryExecutionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:athenaError:QueryExecutionStatus', queryExecutionStatus_athenaError - Provides information about an Athena query error.
$sel:completionDateTime:QueryExecutionStatus', queryExecutionStatus_completionDateTime - The date and time that the query completed.
$sel:state:QueryExecutionStatus', queryExecutionStatus_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.
$sel:stateChangeReason:QueryExecutionStatus', queryExecutionStatus_stateChangeReason - Further detail about the status of the query.
$sel:submissionDateTime:QueryExecutionStatus', queryExecutionStatus_submissionDateTime - The date and time that the query was submitted.
queryExecutionStatus_athenaError :: Lens' QueryExecutionStatus (Maybe AthenaError) Source #
Provides information about an Athena query error.
queryExecutionStatus_completionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime) Source #
The date and time that the query completed.
queryExecutionStatus_state :: Lens' QueryExecutionStatus (Maybe QueryExecutionState) Source #
The state of query execution. QUEUED indicates that the query has been
submitted to the service, and Athena will execute the query as soon as
resources are available. RUNNING indicates that the query is in
execution phase. SUCCEEDED indicates that the query completed without
errors. FAILED indicates that the query experienced an error and did
not complete processing. CANCELLED indicates that a user input
interrupted query execution.
Athena automatically retries your queries in cases of certain transient
errors. As a result, you may see the query state transition from
RUNNING or FAILED to QUEUED.
queryExecutionStatus_stateChangeReason :: Lens' QueryExecutionStatus (Maybe Text) Source #
Further detail about the status of the query.
queryExecutionStatus_submissionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime) Source #
The date and time that the query was submitted.
QueryRuntimeStatistics
data QueryRuntimeStatistics Source #
The query execution timeline, statistics on input and output rows and bytes, and the different query stages that form the query execution plan.
See: newQueryRuntimeStatistics smart constructor.
Constructors
| QueryRuntimeStatistics' | |
Fields
| |
Instances
newQueryRuntimeStatistics :: QueryRuntimeStatistics Source #
Create a value of QueryRuntimeStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:outputStage:QueryRuntimeStatistics', queryRuntimeStatistics_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.
$sel:rows:QueryRuntimeStatistics', queryRuntimeStatistics_rows - Undocumented member.
$sel:timeline:QueryRuntimeStatistics', queryRuntimeStatistics_timeline - Undocumented member.
queryRuntimeStatistics_outputStage :: Lens' QueryRuntimeStatistics (Maybe QueryStage) Source #
Stage statistics such as input and output rows and bytes, execution time, and stage state. This information also includes substages and the query stage plan.
queryRuntimeStatistics_rows :: Lens' QueryRuntimeStatistics (Maybe QueryRuntimeStatisticsRows) Source #
Undocumented member.
queryRuntimeStatistics_timeline :: Lens' QueryRuntimeStatistics (Maybe QueryRuntimeStatisticsTimeline) Source #
Undocumented member.
QueryRuntimeStatisticsRows
data QueryRuntimeStatisticsRows Source #
Statistics such as input rows and bytes read by the query, rows and bytes output by the query, and the number of rows written by the query.
See: newQueryRuntimeStatisticsRows smart constructor.
Constructors
| QueryRuntimeStatisticsRows' | |
Fields
| |
Instances
newQueryRuntimeStatisticsRows :: QueryRuntimeStatisticsRows Source #
Create a value of QueryRuntimeStatisticsRows with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputBytes:QueryRuntimeStatisticsRows', queryRuntimeStatisticsRows_inputBytes - The number of bytes read to execute the query.
$sel:inputRows:QueryRuntimeStatisticsRows', queryRuntimeStatisticsRows_inputRows - The number of rows read to execute the query.
$sel:outputBytes:QueryRuntimeStatisticsRows', queryRuntimeStatisticsRows_outputBytes - The number of bytes returned by the query.
$sel:outputRows:QueryRuntimeStatisticsRows', queryRuntimeStatisticsRows_outputRows - The number of rows returned by the query.
queryRuntimeStatisticsRows_inputBytes :: Lens' QueryRuntimeStatisticsRows (Maybe Integer) Source #
The number of bytes read to execute the query.
queryRuntimeStatisticsRows_inputRows :: Lens' QueryRuntimeStatisticsRows (Maybe Integer) Source #
The number of rows read to execute the query.
queryRuntimeStatisticsRows_outputBytes :: Lens' QueryRuntimeStatisticsRows (Maybe Integer) Source #
The number of bytes returned by the query.
queryRuntimeStatisticsRows_outputRows :: Lens' QueryRuntimeStatisticsRows (Maybe Integer) Source #
The number of rows returned by the query.
QueryRuntimeStatisticsTimeline
data QueryRuntimeStatisticsTimeline Source #
Timeline statistics such as query queue time, planning time, execution time, service processing time, and total execution time.
See: newQueryRuntimeStatisticsTimeline smart constructor.
Constructors
| QueryRuntimeStatisticsTimeline' | |
Fields
| |
Instances
newQueryRuntimeStatisticsTimeline :: QueryRuntimeStatisticsTimeline Source #
Create a value of QueryRuntimeStatisticsTimeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineExecutionTimeInMillis:QueryRuntimeStatisticsTimeline', queryRuntimeStatisticsTimeline_engineExecutionTimeInMillis - The number of milliseconds that the query took to execute.
$sel:queryPlanningTimeInMillis:QueryRuntimeStatisticsTimeline', queryRuntimeStatisticsTimeline_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.
$sel:queryQueueTimeInMillis:QueryRuntimeStatisticsTimeline', queryRuntimeStatisticsTimeline_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.
$sel:serviceProcessingTimeInMillis:QueryRuntimeStatisticsTimeline', queryRuntimeStatisticsTimeline_serviceProcessingTimeInMillis - The number of milliseconds that Athena took to finalize and publish the
query results after the query engine finished running the query.
$sel:totalExecutionTimeInMillis:QueryRuntimeStatisticsTimeline', queryRuntimeStatisticsTimeline_totalExecutionTimeInMillis - The number of milliseconds that Athena took to run the query.
queryRuntimeStatisticsTimeline_engineExecutionTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer) Source #
The number of milliseconds that the query took to execute.
queryRuntimeStatisticsTimeline_queryPlanningTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer) Source #
The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.
queryRuntimeStatisticsTimeline_queryQueueTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer) Source #
The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.
queryRuntimeStatisticsTimeline_serviceProcessingTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer) Source #
The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
queryRuntimeStatisticsTimeline_totalExecutionTimeInMillis :: Lens' QueryRuntimeStatisticsTimeline (Maybe Integer) Source #
The number of milliseconds that Athena took to run the query.
QueryStage
data QueryStage Source #
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.
See: newQueryStage smart constructor.
Constructors
| QueryStage' | |
Fields
| |
Instances
newQueryStage :: QueryStage Source #
Create a value of QueryStage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:executionTime:QueryStage', queryStage_executionTime - Time taken to execute this stage.
$sel:inputBytes:QueryStage', queryStage_inputBytes - The number of bytes input into the stage for execution.
$sel:inputRows:QueryStage', queryStage_inputRows - The number of rows input into the stage for execution.
$sel:outputBytes:QueryStage', queryStage_outputBytes - The number of bytes output from the stage after execution.
$sel:outputRows:QueryStage', queryStage_outputRows - The number of rows output from the stage after execution.
$sel:queryStagePlan:QueryStage', queryStage_queryStagePlan - Stage plan information such as name, identifier, sub plans, and source
stages.
$sel:stageId:QueryStage', queryStage_stageId - The identifier for a stage.
$sel:state:QueryStage', queryStage_state - State of the stage after query execution.
$sel:subStages:QueryStage', queryStage_subStages - List of sub query stages that form this stage execution plan.
queryStage_executionTime :: Lens' QueryStage (Maybe Integer) Source #
Time taken to execute this stage.
queryStage_inputBytes :: Lens' QueryStage (Maybe Integer) Source #
The number of bytes input into the stage for execution.
queryStage_inputRows :: Lens' QueryStage (Maybe Integer) Source #
The number of rows input into the stage for execution.
queryStage_outputBytes :: Lens' QueryStage (Maybe Integer) Source #
The number of bytes output from the stage after execution.
queryStage_outputRows :: Lens' QueryStage (Maybe Integer) Source #
The number of rows output from the stage after execution.
queryStage_queryStagePlan :: Lens' QueryStage (Maybe QueryStagePlanNode) Source #
Stage plan information such as name, identifier, sub plans, and source stages.
queryStage_stageId :: Lens' QueryStage (Maybe Integer) Source #
The identifier for a stage.
queryStage_state :: Lens' QueryStage (Maybe Text) Source #
State of the stage after query execution.
queryStage_subStages :: Lens' QueryStage (Maybe [QueryStage]) Source #
List of sub query stages that form this stage execution plan.
QueryStagePlanNode
data QueryStagePlanNode Source #
Stage plan information such as name, identifier, sub plans, and remote sources.
See: newQueryStagePlanNode smart constructor.
Constructors
| QueryStagePlanNode' | |
Fields
| |
Instances
newQueryStagePlanNode :: QueryStagePlanNode Source #
Create a value of QueryStagePlanNode with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:children:QueryStagePlanNode', queryStagePlanNode_children - Stage plan information such as name, identifier, sub plans, and remote
sources of child plan nodes/
$sel:identifier:QueryStagePlanNode', queryStagePlanNode_identifier - Information about the operation this query stage plan node is
performing.
$sel:name:QueryStagePlanNode', queryStagePlanNode_name - Name of the query stage plan that describes the operation this stage is
performing as part of query execution.
$sel:remoteSources:QueryStagePlanNode', queryStagePlanNode_remoteSources - Source plan node IDs.
queryStagePlanNode_children :: Lens' QueryStagePlanNode (Maybe [QueryStagePlanNode]) Source #
Stage plan information such as name, identifier, sub plans, and remote sources of child plan nodes/
queryStagePlanNode_identifier :: Lens' QueryStagePlanNode (Maybe Text) Source #
Information about the operation this query stage plan node is performing.
queryStagePlanNode_name :: Lens' QueryStagePlanNode (Maybe Text) Source #
Name of the query stage plan that describes the operation this stage is performing as part of query execution.
queryStagePlanNode_remoteSources :: Lens' QueryStagePlanNode (Maybe [Text]) Source #
Source plan node IDs.
ResultConfiguration
data ResultConfiguration Source #
The location in Amazon S3 where query 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 workgroup settings.
See: newResultConfiguration smart constructor.
Constructors
| ResultConfiguration' | |
Fields
| |
Instances
newResultConfiguration :: ResultConfiguration Source #
Create a value of ResultConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aclConfiguration:ResultConfiguration', resultConfiguration_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.
$sel:encryptionConfiguration:ResultConfiguration', resultConfiguration_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.
$sel:expectedBucketOwner:ResultConfiguration', resultConfiguration_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.
$sel:outputLocation:ResultConfiguration', resultConfiguration_outputLocation - The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. To run the query, you must specify
the query results location using one of the ways: either for individual
queries using either this setting (client-side), or in the workgroup,
using WorkGroupConfiguration. If none of them is set, Athena issues an
error that no output location is provided. For more information, see
Query Results.
If workgroup settings override client-side settings, then the query uses
the settings specified for the workgroup. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
resultConfiguration_aclConfiguration :: Lens' ResultConfiguration (Maybe AclConfiguration) Source #
Indicates that an Amazon S3 canned ACL should be set to control
ownership of stored query results. Currently the only supported canned
ACL is BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If
workgroup settings override client-side settings, then the query uses
the ACL configuration that is specified for the workgroup, and also uses
the location for storing query results specified in the workgroup. For
more information, see
WorkGroupConfiguration$EnforceWorkGroupConfiguration and
Workgroup Settings Override Client-Side Settings.
resultConfiguration_encryptionConfiguration :: Lens' ResultConfiguration (Maybe EncryptionConfiguration) Source #
If query results are encrypted in Amazon S3, indicates the encryption
option used (for example, SSE_KMS or CSE_KMS) and key information.
This is a client-side setting. If workgroup settings override
client-side settings, then the query uses the encryption configuration
that is specified for the workgroup, and also uses the location for
storing query results specified in the workgroup. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration and
Workgroup Settings Override Client-Side Settings.
resultConfiguration_expectedBucketOwner :: Lens' ResultConfiguration (Maybe Text) Source #
The Amazon Web Services account ID that you expect to be the owner of
the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If
set, Athena uses the value for ExpectedBucketOwner when it makes
Amazon S3 calls to your specified output location. If the
ExpectedBucketOwner Amazon Web Services account ID does not match the
actual owner of the Amazon S3 bucket, the call fails with a permissions
error.
This is a client-side setting. If workgroup settings override
client-side settings, then the query uses the ExpectedBucketOwner
setting that is specified for the workgroup, and also uses the location
for storing query results specified in the workgroup. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration and
Workgroup Settings Override Client-Side Settings.
resultConfiguration_outputLocation :: Lens' ResultConfiguration (Maybe Text) Source #
The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. To run the query, you must specify
the query results location using one of the ways: either for individual
queries using either this setting (client-side), or in the workgroup,
using WorkGroupConfiguration. If none of them is set, Athena issues an
error that no output location is provided. For more information, see
Query Results.
If workgroup settings override client-side settings, then the query uses
the settings specified for the workgroup. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
ResultConfigurationUpdates
data ResultConfigurationUpdates Source #
The information about the updates in the query results, such as output location and encryption configuration for the query results.
See: newResultConfigurationUpdates smart constructor.
Constructors
| ResultConfigurationUpdates' | |
Fields
| |
Instances
newResultConfigurationUpdates :: ResultConfigurationUpdates Source #
Create a value of ResultConfigurationUpdates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aclConfiguration:ResultConfigurationUpdates', resultConfigurationUpdates_aclConfiguration - The ACL configuration for the query results.
$sel:encryptionConfiguration:ResultConfigurationUpdates', resultConfigurationUpdates_encryptionConfiguration - The encryption configuration for the query results.
$sel:expectedBucketOwner:ResultConfigurationUpdates', resultConfigurationUpdates_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.
$sel:outputLocation:ResultConfigurationUpdates', resultConfigurationUpdates_outputLocation - The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. For more information, see
Query Results
If workgroup settings override client-side settings, then the query uses
the location for the query results and the encryption configuration that
are specified for the workgroup. The "workgroup settings override" is
specified in EnforceWorkGroupConfiguration (true/false) in the
WorkGroupConfiguration. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
$sel:removeAclConfiguration:ResultConfigurationUpdates', resultConfigurationUpdates_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.
$sel:removeEncryptionConfiguration:ResultConfigurationUpdates', resultConfigurationUpdates_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.
$sel:removeExpectedBucketOwner:ResultConfigurationUpdates', resultConfigurationUpdates_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.
$sel:removeOutputLocation:ResultConfigurationUpdates', resultConfigurationUpdates_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.
resultConfigurationUpdates_aclConfiguration :: Lens' ResultConfigurationUpdates (Maybe AclConfiguration) Source #
The ACL configuration for the query results.
resultConfigurationUpdates_encryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe EncryptionConfiguration) Source #
The encryption configuration for the query results.
resultConfigurationUpdates_expectedBucketOwner :: Lens' ResultConfigurationUpdates (Maybe Text) Source #
The Amazon Web Services account ID that you expect to be the owner of
the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If
set, Athena uses the value for ExpectedBucketOwner when it makes
Amazon S3 calls to your specified output location. If the
ExpectedBucketOwner Amazon Web Services account ID does not match the
actual owner of the Amazon S3 bucket, the call fails with a permissions
error.
If workgroup settings override client-side settings, then the query uses
the ExpectedBucketOwner setting that is specified for the workgroup,
and also uses the location for storing query results specified in the
workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and
Workgroup Settings Override Client-Side Settings.
resultConfigurationUpdates_outputLocation :: Lens' ResultConfigurationUpdates (Maybe Text) Source #
The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. For more information, see
Query Results
If workgroup settings override client-side settings, then the query uses
the location for the query results and the encryption configuration that
are specified for the workgroup. The "workgroup settings override" is
specified in EnforceWorkGroupConfiguration (true/false) in the
WorkGroupConfiguration. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
resultConfigurationUpdates_removeAclConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool) Source #
If set to true, indicates that the previously-specified ACL
configuration for queries in this workgroup should be ignored and set to
null. If set to false or not set, and a value is present in the
AclConfiguration of ResultConfigurationUpdates, the
AclConfiguration in the workgroup's ResultConfiguration is updated
with the new value. For more information, see
Workgroup Settings Override Client-Side Settings.
resultConfigurationUpdates_removeEncryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool) Source #
If set to "true", indicates that the previously-specified encryption
configuration (also known as the client-side setting) for queries in
this workgroup should be ignored and set to null. If set to "false" or
not set, and a value is present in the EncryptionConfiguration in
ResultConfigurationUpdates (the client-side setting), the
EncryptionConfiguration in the workgroup's ResultConfiguration will
be updated with the new value. For more information, see
Workgroup Settings Override Client-Side Settings.
resultConfigurationUpdates_removeExpectedBucketOwner :: Lens' ResultConfigurationUpdates (Maybe Bool) Source #
If set to "true", removes the Amazon Web Services account ID
previously specified for ResultConfiguration$ExpectedBucketOwner. If set
to "false" or not set, and a value is present in the
ExpectedBucketOwner in ResultConfigurationUpdates (the client-side
setting), the ExpectedBucketOwner in the workgroup's
ResultConfiguration is updated with the new value. For more
information, see
Workgroup Settings Override Client-Side Settings.
resultConfigurationUpdates_removeOutputLocation :: Lens' ResultConfigurationUpdates (Maybe Bool) Source #
If set to "true", indicates that the previously-specified query
results location (also known as a client-side setting) for queries in
this workgroup should be ignored and set to null. If set to "false" or
not set, and a value is present in the OutputLocation in
ResultConfigurationUpdates (the client-side setting), the
OutputLocation in the workgroup's ResultConfiguration will be
updated with the new value. For more information, see
Workgroup Settings Override Client-Side Settings.
ResultReuseByAgeConfiguration
data ResultReuseByAgeConfiguration Source #
Specifies whether previous query results are reused, and if so, their maximum age.
See: newResultReuseByAgeConfiguration smart constructor.
Constructors
| ResultReuseByAgeConfiguration' | |
Fields
| |
Instances
newResultReuseByAgeConfiguration Source #
Create a value of ResultReuseByAgeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxAgeInMinutes:ResultReuseByAgeConfiguration', resultReuseByAgeConfiguration_maxAgeInMinutes - Specifies, in minutes, the maximum age of a previous query result that
Athena should consider for reuse. The default is 60.
$sel:enabled:ResultReuseByAgeConfiguration', resultReuseByAgeConfiguration_enabled - True if previous query results can be reused when the query is run;
otherwise, false. The default is false.
resultReuseByAgeConfiguration_maxAgeInMinutes :: Lens' ResultReuseByAgeConfiguration (Maybe Natural) Source #
Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default is 60.
resultReuseByAgeConfiguration_enabled :: Lens' ResultReuseByAgeConfiguration Bool Source #
True if previous query results can be reused when the query is run; otherwise, false. The default is false.
ResultReuseConfiguration
data ResultReuseConfiguration Source #
Specifies the query result reuse behavior for the query.
See: newResultReuseConfiguration smart constructor.
Constructors
| ResultReuseConfiguration' | |
Fields
| |
Instances
newResultReuseConfiguration :: ResultReuseConfiguration Source #
Create a value of ResultReuseConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resultReuseByAgeConfiguration:ResultReuseConfiguration', resultReuseConfiguration_resultReuseByAgeConfiguration - Specifies whether previous query results are reused, and if so, their
maximum age.
resultReuseConfiguration_resultReuseByAgeConfiguration :: Lens' ResultReuseConfiguration (Maybe ResultReuseByAgeConfiguration) Source #
Specifies whether previous query results are reused, and if so, their maximum age.
ResultReuseInformation
data ResultReuseInformation Source #
Contains information about whether the result of a previous query was reused.
See: newResultReuseInformation smart constructor.
Constructors
| ResultReuseInformation' | |
Fields
| |
Instances
newResultReuseInformation Source #
Create a value of ResultReuseInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reusedPreviousResult:ResultReuseInformation', resultReuseInformation_reusedPreviousResult - True if a previous query result was reused; false if the result was
generated from a new run of the query.
resultReuseInformation_reusedPreviousResult :: Lens' ResultReuseInformation Bool Source #
True if a previous query result was reused; false if the result was generated from a new run of the query.
ResultSet
The metadata and rows that make up a query result set. The metadata
describes the column structure and data types. To return a ResultSet
object, use GetQueryResults.
See: newResultSet smart constructor.
Constructors
| ResultSet' | |
Fields
| |
Instances
| FromJSON ResultSet Source # | |
| Generic ResultSet Source # | |
| Read ResultSet Source # | |
| Show ResultSet Source # | |
| NFData ResultSet Source # | |
Defined in Amazonka.Athena.Types.ResultSet | |
| Eq ResultSet Source # | |
| Hashable ResultSet Source # | |
Defined in Amazonka.Athena.Types.ResultSet | |
| type Rep ResultSet Source # | |
Defined in Amazonka.Athena.Types.ResultSet type Rep ResultSet = D1 ('MetaData "ResultSet" "Amazonka.Athena.Types.ResultSet" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ResultSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultSetMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResultSetMetadata)) :*: S1 ('MetaSel ('Just "rows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Row])))) | |
newResultSet :: ResultSet Source #
Create a value of ResultSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resultSetMetadata:ResultSet', resultSet_resultSetMetadata - The metadata that describes the column structure and data types of a
table of query results.
$sel:rows:ResultSet', resultSet_rows - The rows in the table.
resultSet_resultSetMetadata :: 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. To return a ResultSetMetadata object, use
GetQueryResults.
See: newResultSetMetadata smart constructor.
Constructors
| ResultSetMetadata' | |
Fields
| |
Instances
newResultSetMetadata :: ResultSetMetadata Source #
Create a value of ResultSetMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columnInfo:ResultSetMetadata', resultSetMetadata_columnInfo - Information about the columns returned in a query result metadata.
resultSetMetadata_columnInfo :: Lens' ResultSetMetadata (Maybe [ColumnInfo]) Source #
Information about the columns returned in a query result metadata.
Row
The rows that make up a query result table.
See: newRow smart constructor.
Create a value of Row with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':Row', row_data - The data that populates a row in a query result table.
row_data :: Lens' Row (Maybe [Datum]) Source #
The data that populates a row in a query result table.
SessionConfiguration
data SessionConfiguration Source #
Contains session configuration information.
See: newSessionConfiguration smart constructor.
Constructors
| SessionConfiguration' | |
Fields
| |
Instances
newSessionConfiguration :: SessionConfiguration Source #
Create a value of SessionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionConfiguration:SessionConfiguration', sessionConfiguration_encryptionConfiguration - Undocumented member.
$sel:executionRole:SessionConfiguration', sessionConfiguration_executionRole - The ARN of the execution role used for the session.
$sel:idleTimeoutSeconds:SessionConfiguration', sessionConfiguration_idleTimeoutSeconds - The idle timeout in seconds for the session.
$sel:workingDirectory:SessionConfiguration', sessionConfiguration_workingDirectory - The Amazon S3 location that stores information for the notebook.
sessionConfiguration_encryptionConfiguration :: Lens' SessionConfiguration (Maybe EncryptionConfiguration) Source #
Undocumented member.
sessionConfiguration_executionRole :: Lens' SessionConfiguration (Maybe Text) Source #
The ARN of the execution role used for the session.
sessionConfiguration_idleTimeoutSeconds :: Lens' SessionConfiguration (Maybe Integer) Source #
The idle timeout in seconds for the session.
sessionConfiguration_workingDirectory :: Lens' SessionConfiguration (Maybe Text) Source #
The Amazon S3 location that stores information for the notebook.
SessionStatistics
data SessionStatistics Source #
Contains statistics for a notebook session.
See: newSessionStatistics smart constructor.
Constructors
| SessionStatistics' | |
Fields
| |
Instances
newSessionStatistics :: SessionStatistics Source #
Create a value of SessionStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dpuExecutionInMillis:SessionStatistics', sessionStatistics_dpuExecutionInMillis - The data processing unit execution time for a session in milliseconds.
sessionStatistics_dpuExecutionInMillis :: Lens' SessionStatistics (Maybe Integer) Source #
The data processing unit execution time for a session in milliseconds.
SessionStatus
data SessionStatus Source #
Contains information about the status of a notebook session.
See: newSessionStatus smart constructor.
Constructors
| SessionStatus' | |
Fields
| |
Instances
newSessionStatus :: SessionStatus Source #
Create a value of SessionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endDateTime:SessionStatus', sessionStatus_endDateTime - The date and time that the session ended.
$sel:idleSinceDateTime:SessionStatus', sessionStatus_idleSinceDateTime - The date and time starting at which the session became idle. Can be
empty if the session is not currently idle.
$sel:lastModifiedDateTime:SessionStatus', sessionStatus_lastModifiedDateTime - The most recent date and time that the session was modified.
$sel:startDateTime:SessionStatus', sessionStatus_startDateTime - The date and time that the session started.
$sel:state:SessionStatus', sessionStatus_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.
$sel:stateChangeReason:SessionStatus', sessionStatus_stateChangeReason - The reason for the session state change (for example, canceled because
the session was terminated).
sessionStatus_endDateTime :: Lens' SessionStatus (Maybe UTCTime) Source #
The date and time that the session ended.
sessionStatus_idleSinceDateTime :: Lens' SessionStatus (Maybe UTCTime) Source #
The date and time starting at which the session became idle. Can be empty if the session is not currently idle.
sessionStatus_lastModifiedDateTime :: Lens' SessionStatus (Maybe UTCTime) Source #
The most recent date and time that the session was modified.
sessionStatus_startDateTime :: Lens' SessionStatus (Maybe UTCTime) Source #
The date and time that the session started.
sessionStatus_state :: Lens' SessionStatus (Maybe SessionState) Source #
The state of the session. A description of each state follows.
CREATING - The session is being started, including acquiring
resources.
CREATED - The session has been started.
IDLE - The session is able to accept a calculation.
BUSY - The session is processing another task and is unable to accept
a calculation.
TERMINATING - The session is in the process of shutting down.
TERMINATED - The session and its resources are no longer running.
DEGRADED - The session has no healthy coordinators.
FAILED - Due to a failure, the session and its resources are no longer
running.
sessionStatus_stateChangeReason :: Lens' SessionStatus (Maybe Text) Source #
The reason for the session state change (for example, canceled because the session was terminated).
SessionSummary
data SessionSummary Source #
Contains summary information about a notebook session.
See: newSessionSummary smart constructor.
Constructors
| SessionSummary' | |
Fields
| |
Instances
newSessionSummary :: SessionSummary Source #
Create a value of SessionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:SessionSummary', sessionSummary_description - The session description.
$sel:engineVersion:SessionSummary', sessionSummary_engineVersion - The engine version used by the session (for example,
PySpark engine version 3).
$sel:notebookVersion:SessionSummary', sessionSummary_notebookVersion - The notebook version.
$sel:sessionId:SessionSummary', sessionSummary_sessionId - The session ID.
$sel:status:SessionSummary', sessionSummary_status - Contains information about the session status.
sessionSummary_description :: Lens' SessionSummary (Maybe Text) Source #
The session description.
sessionSummary_engineVersion :: Lens' SessionSummary (Maybe EngineVersion) Source #
The engine version used by the session (for example,
PySpark engine version 3).
sessionSummary_notebookVersion :: Lens' SessionSummary (Maybe Text) Source #
The notebook version.
sessionSummary_sessionId :: Lens' SessionSummary (Maybe Text) Source #
The session ID.
sessionSummary_status :: Lens' SessionSummary (Maybe SessionStatus) Source #
Contains information about the session status.
TableMetadata
data TableMetadata Source #
Contains metadata for a table.
See: newTableMetadata smart constructor.
Constructors
| TableMetadata' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> TableMetadata |
Create a value of TableMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columns:TableMetadata', tableMetadata_columns - A list of the columns in the table.
$sel:createTime:TableMetadata', tableMetadata_createTime - The time that the table was created.
$sel:lastAccessTime:TableMetadata', tableMetadata_lastAccessTime - The last time the table was accessed.
$sel:parameters:TableMetadata', tableMetadata_parameters - A set of custom key/value pairs for table properties.
$sel:partitionKeys:TableMetadata', tableMetadata_partitionKeys - A list of the partition keys in the table.
$sel:tableType:TableMetadata', tableMetadata_tableType - The type of table. In Athena, only EXTERNAL_TABLE is supported.
TableMetadata, tableMetadata_name - The name of the table.
tableMetadata_columns :: Lens' TableMetadata (Maybe [Column]) Source #
A list of the columns in the table.
tableMetadata_createTime :: Lens' TableMetadata (Maybe UTCTime) Source #
The time that the table was created.
tableMetadata_lastAccessTime :: Lens' TableMetadata (Maybe UTCTime) Source #
The last time the table was accessed.
tableMetadata_parameters :: Lens' TableMetadata (Maybe (HashMap Text Text)) Source #
A set of custom key/value pairs for table properties.
tableMetadata_partitionKeys :: Lens' TableMetadata (Maybe [Column]) Source #
A list of the partition keys in the table.
tableMetadata_tableType :: Lens' TableMetadata (Maybe Text) Source #
The type of table. In Athena, only EXTERNAL_TABLE is supported.
tableMetadata_name :: Lens' TableMetadata Text Source #
The name of the table.
Tag
A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.Athena.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Athena.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.Athena.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.Athena.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Athena.Types.Tag" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_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.
$sel:value:Tag', tag_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.
tag_key :: Lens' Tag (Maybe Text) Source #
A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.
tag_value :: Lens' Tag (Maybe Text) Source #
A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.
UnprocessedNamedQueryId
data UnprocessedNamedQueryId Source #
Information about a named query ID that could not be processed.
See: newUnprocessedNamedQueryId smart constructor.
Constructors
| UnprocessedNamedQueryId' | |
Fields
| |
Instances
newUnprocessedNamedQueryId :: UnprocessedNamedQueryId Source #
Create a value of UnprocessedNamedQueryId with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:UnprocessedNamedQueryId', unprocessedNamedQueryId_errorCode - The error code returned when the processing request for the named query
failed, if applicable.
$sel:errorMessage:UnprocessedNamedQueryId', unprocessedNamedQueryId_errorMessage - The error message returned when the processing request for the named
query failed, if applicable.
$sel:namedQueryId:UnprocessedNamedQueryId', unprocessedNamedQueryId_namedQueryId - The unique identifier of the named query.
unprocessedNamedQueryId_errorCode :: Lens' UnprocessedNamedQueryId (Maybe Text) Source #
The error code returned when the processing request for the named query failed, if applicable.
unprocessedNamedQueryId_errorMessage :: Lens' UnprocessedNamedQueryId (Maybe Text) Source #
The error message returned when the processing request for the named query failed, if applicable.
unprocessedNamedQueryId_namedQueryId :: Lens' UnprocessedNamedQueryId (Maybe Text) Source #
The unique identifier of the named query.
UnprocessedPreparedStatementName
data UnprocessedPreparedStatementName Source #
The name of a prepared statement that could not be returned.
See: newUnprocessedPreparedStatementName smart constructor.
Constructors
| UnprocessedPreparedStatementName' | |
Fields
| |
Instances
newUnprocessedPreparedStatementName :: UnprocessedPreparedStatementName Source #
Create a value of UnprocessedPreparedStatementName with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:UnprocessedPreparedStatementName', unprocessedPreparedStatementName_errorCode - The error code returned when the request for the prepared statement
failed.
$sel:errorMessage:UnprocessedPreparedStatementName', unprocessedPreparedStatementName_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.
$sel:statementName:UnprocessedPreparedStatementName', unprocessedPreparedStatementName_statementName - The name of a prepared statement that could not be returned due to an
error.
unprocessedPreparedStatementName_errorCode :: Lens' UnprocessedPreparedStatementName (Maybe Text) Source #
The error code returned when the request for the prepared statement failed.
unprocessedPreparedStatementName_errorMessage :: Lens' UnprocessedPreparedStatementName (Maybe Text) Source #
The error message containing the reason why the prepared statement could not be returned. The following error messages are possible:
INVALID_INPUT- The name of the prepared statement that was provided is not valid (for example, the name is too long).STATEMENT_NOT_FOUND- A prepared statement with the name provided could not be found.UNAUTHORIZED- The requester does not have permission to access the workgroup that contains the prepared statement.
unprocessedPreparedStatementName_statementName :: Lens' UnprocessedPreparedStatementName (Maybe Text) Source #
The name of a prepared statement that could not be returned due to an error.
UnprocessedQueryExecutionId
data UnprocessedQueryExecutionId Source #
Describes a query execution that failed to process.
See: newUnprocessedQueryExecutionId smart constructor.
Constructors
| UnprocessedQueryExecutionId' | |
Fields
| |
Instances
newUnprocessedQueryExecutionId :: UnprocessedQueryExecutionId Source #
Create a value of UnprocessedQueryExecutionId with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:UnprocessedQueryExecutionId', unprocessedQueryExecutionId_errorCode - The error code returned when the query execution failed to process, if
applicable.
$sel:errorMessage:UnprocessedQueryExecutionId', unprocessedQueryExecutionId_errorMessage - The error message returned when the query execution failed to process,
if applicable.
$sel:queryExecutionId:UnprocessedQueryExecutionId', unprocessedQueryExecutionId_queryExecutionId - The unique identifier of the query execution.
unprocessedQueryExecutionId_errorCode :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #
The error code returned when the query execution failed to process, if applicable.
unprocessedQueryExecutionId_errorMessage :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #
The error message returned when the query execution failed to process, if applicable.
unprocessedQueryExecutionId_queryExecutionId :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #
The unique identifier of the query execution.
WorkGroup
A workgroup, which contains a name, description, creation time, state,
and other configuration, listed under WorkGroup$Configuration. Each
workgroup enables you to isolate queries for you or your group of users
from other queries in the same account, to configure the query results
location and the encryption configuration (known as workgroup settings),
to enable sending query metrics to Amazon CloudWatch, and to establish
per-query data usage control limits for all queries in a workgroup. The
workgroup settings override is specified in
EnforceWorkGroupConfiguration (true/false) in the
WorkGroupConfiguration. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
See: newWorkGroup smart constructor.
Constructors
| WorkGroup' | |
Fields
| |
Instances
Create a value of WorkGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configuration:WorkGroup', workGroup_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 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.
$sel:creationTime:WorkGroup', workGroup_creationTime - The date and time the workgroup was created.
$sel:description:WorkGroup', workGroup_description - The workgroup description.
$sel:state:WorkGroup', workGroup_state - The state of the workgroup: ENABLED or DISABLED.
$sel:name:WorkGroup', workGroup_name - The workgroup name.
workGroup_configuration :: Lens' WorkGroup (Maybe WorkGroupConfiguration) Source #
The configuration of the workgroup, which includes the location in
Amazon S3 where query results are stored, the encryption configuration,
if any, used for query results; whether the Amazon CloudWatch Metrics
are enabled for the workgroup; whether workgroup settings override
client-side settings; and the data usage limits for the amount of data
scanned per query or per workgroup. The workgroup settings override is
specified in EnforceWorkGroupConfiguration (true/false) in the
WorkGroupConfiguration. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
workGroup_creationTime :: Lens' WorkGroup (Maybe UTCTime) Source #
The date and time the workgroup was created.
workGroup_state :: Lens' WorkGroup (Maybe WorkGroupState) Source #
The state of the workgroup: ENABLED or DISABLED.
WorkGroupConfiguration
data WorkGroupConfiguration Source #
The configuration of the workgroup, which includes the location in
Amazon S3 where query results are stored, the encryption option, if any,
used for query results, whether the Amazon CloudWatch Metrics are
enabled for the workgroup and whether workgroup settings override query
settings, and the data usage limits for the amount of data scanned per
query or per workgroup. The workgroup settings override is specified in
EnforceWorkGroupConfiguration (true/false) in the
WorkGroupConfiguration. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
See: newWorkGroupConfiguration smart constructor.
Constructors
| WorkGroupConfiguration' | |
Fields
| |
Instances
newWorkGroupConfiguration :: WorkGroupConfiguration Source #
Create a value of WorkGroupConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalConfiguration:WorkGroupConfiguration', workGroupConfiguration_additionalConfiguration - Specifies a user defined JSON string that is passed to the notebook
engine.
$sel:bytesScannedCutoffPerQuery:WorkGroupConfiguration', workGroupConfiguration_bytesScannedCutoffPerQuery - The upper data usage limit (cutoff) for the amount of bytes a single
query in a workgroup is allowed to scan.
$sel:customerContentEncryptionConfiguration:WorkGroupConfiguration', workGroupConfiguration_customerContentEncryptionConfiguration - Specifies the KMS key that is used to encrypt the user's data stores in
Athena.
$sel:enforceWorkGroupConfiguration:WorkGroupConfiguration', workGroupConfiguration_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.
$sel:engineVersion:WorkGroupConfiguration', workGroupConfiguration_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.
$sel:executionRole:WorkGroupConfiguration', workGroupConfiguration_executionRole - Role used in a notebook session for accessing the user's resources.
$sel:publishCloudWatchMetricsEnabled:WorkGroupConfiguration', workGroupConfiguration_publishCloudWatchMetricsEnabled - Indicates that the Amazon CloudWatch metrics are enabled for the
workgroup.
$sel:requesterPaysEnabled:WorkGroupConfiguration', workGroupConfiguration_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.
$sel:resultConfiguration:WorkGroupConfiguration', workGroupConfiguration_resultConfiguration - The configuration for the workgroup, which includes the location in
Amazon S3 where query results are stored and the encryption option, if
any, used for query results. To run the query, you must specify the
query results location using one of the ways: either in the workgroup
using this setting, or for individual queries (client-side), using
ResultConfiguration$OutputLocation. If none of them is set, Athena
issues an error that no output location is provided. For more
information, see
Query Results.
workGroupConfiguration_additionalConfiguration :: Lens' WorkGroupConfiguration (Maybe Text) Source #
Specifies a user defined JSON string that is passed to the notebook engine.
workGroupConfiguration_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfiguration (Maybe Natural) Source #
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
workGroupConfiguration_customerContentEncryptionConfiguration :: Lens' WorkGroupConfiguration (Maybe CustomerContentEncryptionConfiguration) Source #
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
workGroupConfiguration_enforceWorkGroupConfiguration :: Lens' WorkGroupConfiguration (Maybe Bool) Source #
If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
workGroupConfiguration_engineVersion :: Lens' WorkGroupConfiguration (Maybe EngineVersion) Source #
The engine version that all queries running on the workgroup use.
Queries on the AmazonAthenaPreviewFunctionality workgroup run on the
preview engine regardless of this setting.
workGroupConfiguration_executionRole :: Lens' WorkGroupConfiguration (Maybe Text) Source #
Role used in a notebook session for accessing the user's resources.
workGroupConfiguration_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfiguration (Maybe Bool) Source #
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
workGroupConfiguration_requesterPaysEnabled :: Lens' WorkGroupConfiguration (Maybe Bool) Source #
If set to true, allows members assigned to a workgroup to reference
Amazon S3 Requester Pays buckets in queries. If set to false,
workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error.
The default is false. For more information about Requester Pays
buckets, see
Requester Pays Buckets
in the Amazon Simple Storage Service Developer Guide.
workGroupConfiguration_resultConfiguration :: Lens' WorkGroupConfiguration (Maybe ResultConfiguration) Source #
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.
WorkGroupConfigurationUpdates
data WorkGroupConfigurationUpdates Source #
The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.
See: newWorkGroupConfigurationUpdates smart constructor.
Constructors
| WorkGroupConfigurationUpdates' | |
Fields
| |
Instances
newWorkGroupConfigurationUpdates :: WorkGroupConfigurationUpdates Source #
Create a value of WorkGroupConfigurationUpdates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalConfiguration:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_additionalConfiguration - Contains a user defined string in JSON format for a Spark-enabled
workgroup.
$sel:bytesScannedCutoffPerQuery:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_bytesScannedCutoffPerQuery - The upper limit (cutoff) for the amount of bytes a single query in a
workgroup is allowed to scan.
$sel:customerContentEncryptionConfiguration:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_customerContentEncryptionConfiguration - Undocumented member.
$sel:enforceWorkGroupConfiguration:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_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.
$sel:engineVersion:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_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.
$sel:executionRole:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_executionRole - Contains the ARN of the execution role for the workgroup
$sel:publishCloudWatchMetricsEnabled:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_publishCloudWatchMetricsEnabled - Indicates whether this workgroup enables publishing metrics to Amazon
CloudWatch.
$sel:removeBytesScannedCutoffPerQuery:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_removeBytesScannedCutoffPerQuery - Indicates that the data usage control limit per query is removed.
WorkGroupConfiguration$BytesScannedCutoffPerQuery
$sel:removeCustomerContentEncryptionConfiguration:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_removeCustomerContentEncryptionConfiguration - Removes content encryption configuration for a workgroup.
$sel:requesterPaysEnabled:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_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.
$sel:resultConfigurationUpdates:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_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.
workGroupConfigurationUpdates_additionalConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Text) Source #
Contains a user defined string in JSON format for a Spark-enabled workgroup.
workGroupConfigurationUpdates_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Natural) Source #
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
workGroupConfigurationUpdates_customerContentEncryptionConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe CustomerContentEncryptionConfiguration) Source #
Undocumented member.
workGroupConfigurationUpdates_enforceWorkGroupConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #
If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
workGroupConfigurationUpdates_engineVersion :: Lens' WorkGroupConfigurationUpdates (Maybe EngineVersion) Source #
The engine version requested when a workgroup is updated. After the
update, all queries on the workgroup run on the requested engine
version. If no value was previously set, the default is Auto. Queries on
the AmazonAthenaPreviewFunctionality workgroup run on the preview
engine regardless of this setting.
workGroupConfigurationUpdates_executionRole :: Lens' WorkGroupConfigurationUpdates (Maybe Text) Source #
Contains the ARN of the execution role for the workgroup
workGroupConfigurationUpdates_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #
Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
workGroupConfigurationUpdates_removeBytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #
Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
workGroupConfigurationUpdates_removeCustomerContentEncryptionConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #
Removes content encryption configuration for a workgroup.
workGroupConfigurationUpdates_requesterPaysEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #
If set to true, allows members assigned to a workgroup to specify
Amazon S3 Requester Pays buckets in queries. If set to false,
workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error.
The default is false. For more information about Requester Pays
buckets, see
Requester Pays Buckets
in the Amazon Simple Storage Service Developer Guide.
workGroupConfigurationUpdates_resultConfigurationUpdates :: Lens' WorkGroupConfigurationUpdates (Maybe ResultConfigurationUpdates) Source #
The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
WorkGroupSummary
data WorkGroupSummary Source #
The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.
See: newWorkGroupSummary smart constructor.
Constructors
| WorkGroupSummary' | |
Fields
| |
Instances
newWorkGroupSummary :: WorkGroupSummary Source #
Create a value of WorkGroupSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:WorkGroupSummary', workGroupSummary_creationTime - The workgroup creation date and time.
$sel:description:WorkGroupSummary', workGroupSummary_description - The workgroup description.
$sel:engineVersion:WorkGroupSummary', workGroupSummary_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.
$sel:name:WorkGroupSummary', workGroupSummary_name - The name of the workgroup.
$sel:state:WorkGroupSummary', workGroupSummary_state - The state of the workgroup.
workGroupSummary_creationTime :: Lens' WorkGroupSummary (Maybe UTCTime) Source #
The workgroup creation date and time.
workGroupSummary_description :: Lens' WorkGroupSummary (Maybe Text) Source #
The workgroup description.
workGroupSummary_engineVersion :: Lens' WorkGroupSummary (Maybe EngineVersion) Source #
The engine version setting for all queries on the workgroup. Queries on
the AmazonAthenaPreviewFunctionality workgroup run on the preview
engine regardless of this setting.
workGroupSummary_name :: Lens' WorkGroupSummary (Maybe Text) Source #
The name of the workgroup.
workGroupSummary_state :: Lens' WorkGroupSummary (Maybe WorkGroupState) Source #
The state of the workgroup.