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 |
- Service Configuration
- Errors
- Waiters
- Operations
- BatchGetNamedQuery
- BatchGetPreparedStatement
- BatchGetQueryExecution
- CreateDataCatalog
- CreateNamedQuery
- CreateNotebook
- CreatePreparedStatement
- CreatePresignedNotebookUrl
- CreateWorkGroup
- DeleteDataCatalog
- DeleteNamedQuery
- DeleteNotebook
- DeletePreparedStatement
- DeleteWorkGroup
- ExportNotebook
- GetCalculationExecution
- GetCalculationExecutionCode
- GetCalculationExecutionStatus
- GetDataCatalog
- GetDatabase
- GetNamedQuery
- GetNotebookMetadata
- GetPreparedStatement
- GetQueryExecution
- GetQueryResults (Paginated)
- GetQueryRuntimeStatistics
- GetSession
- GetSessionStatus
- GetTableMetadata
- GetWorkGroup
- ImportNotebook
- ListApplicationDPUSizes
- ListCalculationExecutions
- ListDataCatalogs (Paginated)
- ListDatabases (Paginated)
- ListEngineVersions
- ListExecutors
- ListNamedQueries (Paginated)
- ListNotebookMetadata
- ListNotebookSessions
- ListPreparedStatements
- ListQueryExecutions (Paginated)
- ListSessions
- ListTableMetadata (Paginated)
- ListTagsForResource (Paginated)
- ListWorkGroups
- StartCalculationExecution
- StartQueryExecution
- StartSession
- StopCalculationExecution
- StopQueryExecution
- TagResource
- TerminateSession
- UntagResource
- UpdateDataCatalog
- UpdateNamedQuery
- UpdateNotebook
- UpdateNotebookMetadata
- UpdatePreparedStatement
- UpdateWorkGroup
- Types
- 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
Derived from API version 2017-05-18
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide.
If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
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
- data BatchGetNamedQuery = BatchGetNamedQuery' (NonEmpty Text)
- newBatchGetNamedQuery :: NonEmpty Text -> BatchGetNamedQuery
- data BatchGetNamedQueryResponse = BatchGetNamedQueryResponse' (Maybe [NamedQuery]) (Maybe [UnprocessedNamedQueryId]) Int
- newBatchGetNamedQueryResponse :: Int -> BatchGetNamedQueryResponse
- data BatchGetPreparedStatement = BatchGetPreparedStatement' [Text] Text
- newBatchGetPreparedStatement :: Text -> BatchGetPreparedStatement
- data BatchGetPreparedStatementResponse = BatchGetPreparedStatementResponse' (Maybe [PreparedStatement]) (Maybe [UnprocessedPreparedStatementName]) Int
- newBatchGetPreparedStatementResponse :: Int -> BatchGetPreparedStatementResponse
- data BatchGetQueryExecution = BatchGetQueryExecution' (NonEmpty Text)
- newBatchGetQueryExecution :: NonEmpty Text -> BatchGetQueryExecution
- data BatchGetQueryExecutionResponse = BatchGetQueryExecutionResponse' (Maybe [QueryExecution]) (Maybe [UnprocessedQueryExecutionId]) Int
- newBatchGetQueryExecutionResponse :: Int -> BatchGetQueryExecutionResponse
- data CreateDataCatalog = CreateDataCatalog' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Tag]) Text DataCatalogType
- newCreateDataCatalog :: Text -> DataCatalogType -> CreateDataCatalog
- data CreateDataCatalogResponse = CreateDataCatalogResponse' Int
- newCreateDataCatalogResponse :: Int -> CreateDataCatalogResponse
- data CreateNamedQuery = CreateNamedQuery' (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text
- newCreateNamedQuery :: Text -> Text -> Text -> CreateNamedQuery
- data CreateNamedQueryResponse = CreateNamedQueryResponse' (Maybe Text) Int
- newCreateNamedQueryResponse :: Int -> CreateNamedQueryResponse
- data CreateNotebook = CreateNotebook' (Maybe Text) Text Text
- newCreateNotebook :: Text -> Text -> CreateNotebook
- data CreateNotebookResponse = CreateNotebookResponse' (Maybe Text) Int
- newCreateNotebookResponse :: Int -> CreateNotebookResponse
- data CreatePreparedStatement = CreatePreparedStatement' (Maybe Text) Text Text Text
- newCreatePreparedStatement :: Text -> Text -> Text -> CreatePreparedStatement
- data CreatePreparedStatementResponse = CreatePreparedStatementResponse' Int
- newCreatePreparedStatementResponse :: Int -> CreatePreparedStatementResponse
- data CreatePresignedNotebookUrl = CreatePresignedNotebookUrl' Text
- newCreatePresignedNotebookUrl :: Text -> CreatePresignedNotebookUrl
- data CreatePresignedNotebookUrlResponse = CreatePresignedNotebookUrlResponse' Int Text Text Integer
- newCreatePresignedNotebookUrlResponse :: Int -> Text -> Text -> Integer -> CreatePresignedNotebookUrlResponse
- data CreateWorkGroup = CreateWorkGroup' (Maybe WorkGroupConfiguration) (Maybe Text) (Maybe [Tag]) Text
- newCreateWorkGroup :: Text -> CreateWorkGroup
- data CreateWorkGroupResponse = CreateWorkGroupResponse' Int
- newCreateWorkGroupResponse :: Int -> CreateWorkGroupResponse
- data DeleteDataCatalog = DeleteDataCatalog' Text
- newDeleteDataCatalog :: Text -> DeleteDataCatalog
- data DeleteDataCatalogResponse = DeleteDataCatalogResponse' Int
- newDeleteDataCatalogResponse :: Int -> DeleteDataCatalogResponse
- data DeleteNamedQuery = DeleteNamedQuery' Text
- newDeleteNamedQuery :: Text -> DeleteNamedQuery
- data DeleteNamedQueryResponse = DeleteNamedQueryResponse' Int
- newDeleteNamedQueryResponse :: Int -> DeleteNamedQueryResponse
- data DeleteNotebook = DeleteNotebook' Text
- newDeleteNotebook :: Text -> DeleteNotebook
- data DeleteNotebookResponse = DeleteNotebookResponse' Int
- newDeleteNotebookResponse :: Int -> DeleteNotebookResponse
- data DeletePreparedStatement = DeletePreparedStatement' Text Text
- newDeletePreparedStatement :: Text -> Text -> DeletePreparedStatement
- data DeletePreparedStatementResponse = DeletePreparedStatementResponse' Int
- newDeletePreparedStatementResponse :: Int -> DeletePreparedStatementResponse
- data DeleteWorkGroup = DeleteWorkGroup' (Maybe Bool) Text
- newDeleteWorkGroup :: Text -> DeleteWorkGroup
- data DeleteWorkGroupResponse = DeleteWorkGroupResponse' Int
- newDeleteWorkGroupResponse :: Int -> DeleteWorkGroupResponse
- data ExportNotebook = ExportNotebook' Text
- newExportNotebook :: Text -> ExportNotebook
- data ExportNotebookResponse = ExportNotebookResponse' (Maybe NotebookMetadata) (Maybe Text) Int
- newExportNotebookResponse :: Int -> ExportNotebookResponse
- data GetCalculationExecution = GetCalculationExecution' Text
- newGetCalculationExecution :: Text -> GetCalculationExecution
- data GetCalculationExecutionResponse = GetCalculationExecutionResponse' (Maybe Text) (Maybe Text) (Maybe CalculationResult) (Maybe Text) (Maybe CalculationStatistics) (Maybe CalculationStatus) (Maybe Text) Int
- newGetCalculationExecutionResponse :: Int -> GetCalculationExecutionResponse
- data GetCalculationExecutionCode = GetCalculationExecutionCode' Text
- newGetCalculationExecutionCode :: Text -> GetCalculationExecutionCode
- data GetCalculationExecutionCodeResponse = GetCalculationExecutionCodeResponse' (Maybe Text) Int
- newGetCalculationExecutionCodeResponse :: Int -> GetCalculationExecutionCodeResponse
- data GetCalculationExecutionStatus = GetCalculationExecutionStatus' Text
- newGetCalculationExecutionStatus :: Text -> GetCalculationExecutionStatus
- data GetCalculationExecutionStatusResponse = GetCalculationExecutionStatusResponse' (Maybe CalculationStatistics) (Maybe CalculationStatus) Int
- newGetCalculationExecutionStatusResponse :: Int -> GetCalculationExecutionStatusResponse
- data GetDataCatalog = GetDataCatalog' Text
- newGetDataCatalog :: Text -> GetDataCatalog
- data GetDataCatalogResponse = GetDataCatalogResponse' (Maybe DataCatalog) Int
- newGetDataCatalogResponse :: Int -> GetDataCatalogResponse
- data GetDatabase = GetDatabase' Text Text
- newGetDatabase :: Text -> Text -> GetDatabase
- data GetDatabaseResponse = GetDatabaseResponse' (Maybe Database) Int
- newGetDatabaseResponse :: Int -> GetDatabaseResponse
- data GetNamedQuery = GetNamedQuery' Text
- newGetNamedQuery :: Text -> GetNamedQuery
- data GetNamedQueryResponse = GetNamedQueryResponse' (Maybe NamedQuery) Int
- newGetNamedQueryResponse :: Int -> GetNamedQueryResponse
- data GetNotebookMetadata = GetNotebookMetadata' Text
- newGetNotebookMetadata :: Text -> GetNotebookMetadata
- data GetNotebookMetadataResponse = GetNotebookMetadataResponse' (Maybe NotebookMetadata) Int
- newGetNotebookMetadataResponse :: Int -> GetNotebookMetadataResponse
- data GetPreparedStatement = GetPreparedStatement' Text Text
- newGetPreparedStatement :: Text -> Text -> GetPreparedStatement
- data GetPreparedStatementResponse = GetPreparedStatementResponse' (Maybe PreparedStatement) Int
- newGetPreparedStatementResponse :: Int -> GetPreparedStatementResponse
- data GetQueryExecution = GetQueryExecution' Text
- newGetQueryExecution :: Text -> GetQueryExecution
- data GetQueryExecutionResponse = GetQueryExecutionResponse' (Maybe QueryExecution) Int
- newGetQueryExecutionResponse :: Int -> GetQueryExecutionResponse
- data GetQueryResults = GetQueryResults' (Maybe Natural) (Maybe Text) Text
- newGetQueryResults :: Text -> GetQueryResults
- data GetQueryResultsResponse = GetQueryResultsResponse' (Maybe Text) (Maybe ResultSet) (Maybe Integer) Int
- newGetQueryResultsResponse :: Int -> GetQueryResultsResponse
- data GetQueryRuntimeStatistics = GetQueryRuntimeStatistics' Text
- newGetQueryRuntimeStatistics :: Text -> GetQueryRuntimeStatistics
- data GetQueryRuntimeStatisticsResponse = GetQueryRuntimeStatisticsResponse' (Maybe QueryRuntimeStatistics) Int
- newGetQueryRuntimeStatisticsResponse :: Int -> GetQueryRuntimeStatisticsResponse
- data GetSession = GetSession' Text
- newGetSession :: Text -> GetSession
- data GetSessionResponse = GetSessionResponse' (Maybe Text) (Maybe EngineConfiguration) (Maybe Text) (Maybe Text) (Maybe SessionConfiguration) (Maybe Text) (Maybe SessionStatistics) (Maybe SessionStatus) (Maybe Text) Int
- newGetSessionResponse :: Int -> GetSessionResponse
- data GetSessionStatus = GetSessionStatus' Text
- newGetSessionStatus :: Text -> GetSessionStatus
- data GetSessionStatusResponse = GetSessionStatusResponse' (Maybe Text) (Maybe SessionStatus) Int
- newGetSessionStatusResponse :: Int -> GetSessionStatusResponse
- data GetTableMetadata = GetTableMetadata' Text Text Text
- newGetTableMetadata :: Text -> Text -> Text -> GetTableMetadata
- data GetTableMetadataResponse = GetTableMetadataResponse' (Maybe TableMetadata) Int
- newGetTableMetadataResponse :: Int -> GetTableMetadataResponse
- data GetWorkGroup = GetWorkGroup' Text
- newGetWorkGroup :: Text -> GetWorkGroup
- data GetWorkGroupResponse = GetWorkGroupResponse' (Maybe WorkGroup) Int
- newGetWorkGroupResponse :: Int -> GetWorkGroupResponse
- data ImportNotebook = ImportNotebook' (Maybe Text) Text Text Text NotebookType
- newImportNotebook :: Text -> Text -> Text -> NotebookType -> ImportNotebook
- data ImportNotebookResponse = ImportNotebookResponse' (Maybe Text) Int
- newImportNotebookResponse :: Int -> ImportNotebookResponse
- data ListApplicationDPUSizes = ListApplicationDPUSizes' (Maybe Natural) (Maybe Text)
- newListApplicationDPUSizes :: ListApplicationDPUSizes
- data ListApplicationDPUSizesResponse = ListApplicationDPUSizesResponse' (Maybe [ApplicationDPUSizes]) (Maybe Text) Int
- newListApplicationDPUSizesResponse :: Int -> ListApplicationDPUSizesResponse
- data ListCalculationExecutions = ListCalculationExecutions' (Maybe Natural) (Maybe Text) (Maybe CalculationExecutionState) Text
- newListCalculationExecutions :: Text -> ListCalculationExecutions
- data ListCalculationExecutionsResponse = ListCalculationExecutionsResponse' (Maybe [CalculationSummary]) (Maybe Text) Int
- newListCalculationExecutionsResponse :: Int -> ListCalculationExecutionsResponse
- data ListDataCatalogs = ListDataCatalogs' (Maybe Natural) (Maybe Text)
- newListDataCatalogs :: ListDataCatalogs
- data ListDataCatalogsResponse = ListDataCatalogsResponse' (Maybe [DataCatalogSummary]) (Maybe Text) Int
- newListDataCatalogsResponse :: Int -> ListDataCatalogsResponse
- data ListDatabases = ListDatabases' (Maybe Natural) (Maybe Text) Text
- newListDatabases :: Text -> ListDatabases
- data ListDatabasesResponse = ListDatabasesResponse' (Maybe [Database]) (Maybe Text) Int
- newListDatabasesResponse :: Int -> ListDatabasesResponse
- data ListEngineVersions = ListEngineVersions' (Maybe Natural) (Maybe Text)
- newListEngineVersions :: ListEngineVersions
- data ListEngineVersionsResponse = ListEngineVersionsResponse' (Maybe [EngineVersion]) (Maybe Text) Int
- newListEngineVersionsResponse :: Int -> ListEngineVersionsResponse
- data ListExecutors = ListExecutors' (Maybe ExecutorState) (Maybe Natural) (Maybe Text) Text
- newListExecutors :: Text -> ListExecutors
- data ListExecutorsResponse = ListExecutorsResponse' (Maybe [ExecutorsSummary]) (Maybe Text) Int Text
- newListExecutorsResponse :: Int -> Text -> ListExecutorsResponse
- data ListNamedQueries = ListNamedQueries' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListNamedQueries :: ListNamedQueries
- data ListNamedQueriesResponse = ListNamedQueriesResponse' (Maybe (NonEmpty Text)) (Maybe Text) Int
- newListNamedQueriesResponse :: Int -> ListNamedQueriesResponse
- data ListNotebookMetadata = ListNotebookMetadata' (Maybe FilterDefinition) (Maybe Natural) (Maybe Text) Text
- newListNotebookMetadata :: Text -> ListNotebookMetadata
- data ListNotebookMetadataResponse = ListNotebookMetadataResponse' (Maybe Text) (Maybe [NotebookMetadata]) Int
- newListNotebookMetadataResponse :: Int -> ListNotebookMetadataResponse
- data ListNotebookSessions = ListNotebookSessions' (Maybe Natural) (Maybe Text) Text
- newListNotebookSessions :: Text -> ListNotebookSessions
- data ListNotebookSessionsResponse = ListNotebookSessionsResponse' (Maybe Text) Int [NotebookSessionSummary]
- newListNotebookSessionsResponse :: Int -> ListNotebookSessionsResponse
- data ListPreparedStatements = ListPreparedStatements' (Maybe Natural) (Maybe Text) Text
- newListPreparedStatements :: Text -> ListPreparedStatements
- data ListPreparedStatementsResponse = ListPreparedStatementsResponse' (Maybe Text) (Maybe [PreparedStatementSummary]) Int
- newListPreparedStatementsResponse :: Int -> ListPreparedStatementsResponse
- data ListQueryExecutions = ListQueryExecutions' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListQueryExecutions :: ListQueryExecutions
- data ListQueryExecutionsResponse = ListQueryExecutionsResponse' (Maybe Text) (Maybe (NonEmpty Text)) Int
- newListQueryExecutionsResponse :: Int -> ListQueryExecutionsResponse
- data ListSessions = ListSessions' (Maybe Natural) (Maybe Text) (Maybe SessionState) Text
- newListSessions :: Text -> ListSessions
- data ListSessionsResponse = ListSessionsResponse' (Maybe Text) (Maybe [SessionSummary]) Int
- newListSessionsResponse :: Int -> ListSessionsResponse
- data ListTableMetadata = ListTableMetadata' (Maybe Text) (Maybe Natural) (Maybe Text) Text Text
- newListTableMetadata :: Text -> Text -> ListTableMetadata
- data ListTableMetadataResponse = ListTableMetadataResponse' (Maybe Text) (Maybe [TableMetadata]) Int
- newListTableMetadataResponse :: Int -> ListTableMetadataResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListWorkGroups = ListWorkGroups' (Maybe Natural) (Maybe Text)
- newListWorkGroups :: ListWorkGroups
- data ListWorkGroupsResponse = ListWorkGroupsResponse' (Maybe Text) (Maybe [WorkGroupSummary]) Int
- newListWorkGroupsResponse :: Int -> ListWorkGroupsResponse
- data StartCalculationExecution = StartCalculationExecution' (Maybe CalculationConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newStartCalculationExecution :: Text -> StartCalculationExecution
- data StartCalculationExecutionResponse = StartCalculationExecutionResponse' (Maybe Text) (Maybe CalculationExecutionState) Int
- newStartCalculationExecutionResponse :: Int -> StartCalculationExecutionResponse
- data StartQueryExecution = StartQueryExecution' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe QueryExecutionContext) (Maybe ResultConfiguration) (Maybe ResultReuseConfiguration) (Maybe Text) Text
- newStartQueryExecution :: Text -> StartQueryExecution
- data StartQueryExecutionResponse = StartQueryExecutionResponse' (Maybe Text) Int
- newStartQueryExecutionResponse :: Int -> StartQueryExecutionResponse
- data StartSession = StartSession' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) Text EngineConfiguration
- newStartSession :: Text -> EngineConfiguration -> StartSession
- data StartSessionResponse = StartSessionResponse' (Maybe Text) (Maybe SessionState) Int
- newStartSessionResponse :: Int -> StartSessionResponse
- data StopCalculationExecution = StopCalculationExecution' Text
- newStopCalculationExecution :: Text -> StopCalculationExecution
- data StopCalculationExecutionResponse = StopCalculationExecutionResponse' (Maybe CalculationExecutionState) Int
- newStopCalculationExecutionResponse :: Int -> StopCalculationExecutionResponse
- data StopQueryExecution = StopQueryExecution' Text
- newStopQueryExecution :: Text -> StopQueryExecution
- data StopQueryExecutionResponse = StopQueryExecutionResponse' Int
- newStopQueryExecutionResponse :: Int -> StopQueryExecutionResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data TerminateSession = TerminateSession' Text
- newTerminateSession :: Text -> TerminateSession
- data TerminateSessionResponse = TerminateSessionResponse' (Maybe SessionState) Int
- newTerminateSessionResponse :: Int -> TerminateSessionResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDataCatalog = UpdateDataCatalog' (Maybe Text) (Maybe (HashMap Text Text)) Text DataCatalogType
- newUpdateDataCatalog :: Text -> DataCatalogType -> UpdateDataCatalog
- data UpdateDataCatalogResponse = UpdateDataCatalogResponse' Int
- newUpdateDataCatalogResponse :: Int -> UpdateDataCatalogResponse
- data UpdateNamedQuery = UpdateNamedQuery' (Maybe Text) Text Text Text
- newUpdateNamedQuery :: Text -> Text -> Text -> UpdateNamedQuery
- data UpdateNamedQueryResponse = UpdateNamedQueryResponse' Int
- newUpdateNamedQueryResponse :: Int -> UpdateNamedQueryResponse
- data UpdateNotebook = UpdateNotebook' (Maybe Text) (Maybe Text) Text Text NotebookType
- newUpdateNotebook :: Text -> Text -> NotebookType -> UpdateNotebook
- data UpdateNotebookResponse = UpdateNotebookResponse' Int
- newUpdateNotebookResponse :: Int -> UpdateNotebookResponse
- data UpdateNotebookMetadata = UpdateNotebookMetadata' (Maybe Text) Text Text
- newUpdateNotebookMetadata :: Text -> Text -> UpdateNotebookMetadata
- data UpdateNotebookMetadataResponse = UpdateNotebookMetadataResponse' Int
- newUpdateNotebookMetadataResponse :: Int -> UpdateNotebookMetadataResponse
- data UpdatePreparedStatement = UpdatePreparedStatement' (Maybe Text) Text Text Text
- newUpdatePreparedStatement :: Text -> Text -> Text -> UpdatePreparedStatement
- data UpdatePreparedStatementResponse = UpdatePreparedStatementResponse' Int
- newUpdatePreparedStatementResponse :: Int -> UpdatePreparedStatementResponse
- data UpdateWorkGroup = UpdateWorkGroup' (Maybe WorkGroupConfigurationUpdates) (Maybe Text) (Maybe WorkGroupState) Text
- newUpdateWorkGroup :: Text -> UpdateWorkGroup
- data UpdateWorkGroupResponse = UpdateWorkGroupResponse' Int
- newUpdateWorkGroupResponse :: Int -> UpdateWorkGroupResponse
- 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' S3AclOption
- newAclConfiguration :: S3AclOption -> AclConfiguration
- data ApplicationDPUSizes = ApplicationDPUSizes' (Maybe Text) (Maybe [Int])
- newApplicationDPUSizes :: ApplicationDPUSizes
- data AthenaError = AthenaError' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Bool)
- newAthenaError :: AthenaError
- data CalculationConfiguration = CalculationConfiguration' (Maybe Text)
- newCalculationConfiguration :: CalculationConfiguration
- data CalculationResult = CalculationResult' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newCalculationResult :: CalculationResult
- data CalculationStatistics = CalculationStatistics' (Maybe Integer) (Maybe Text)
- newCalculationStatistics :: CalculationStatistics
- data CalculationStatus = CalculationStatus' (Maybe POSIX) (Maybe CalculationExecutionState) (Maybe Text) (Maybe POSIX)
- newCalculationStatus :: CalculationStatus
- data CalculationSummary = CalculationSummary' (Maybe Text) (Maybe Text) (Maybe CalculationStatus)
- newCalculationSummary :: CalculationSummary
- data Column = Column' (Maybe Text) (Maybe Text) Text
- newColumn :: Text -> Column
- data ColumnInfo = ColumnInfo' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ColumnNullable) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) Text Text
- newColumnInfo :: Text -> Text -> ColumnInfo
- data CustomerContentEncryptionConfiguration = CustomerContentEncryptionConfiguration' Text
- newCustomerContentEncryptionConfiguration :: Text -> CustomerContentEncryptionConfiguration
- data DataCatalog = DataCatalog' (Maybe Text) (Maybe (HashMap Text Text)) Text DataCatalogType
- newDataCatalog :: Text -> DataCatalogType -> DataCatalog
- data DataCatalogSummary = DataCatalogSummary' (Maybe Text) (Maybe DataCatalogType)
- newDataCatalogSummary :: DataCatalogSummary
- data Database = Database' (Maybe Text) (Maybe (HashMap Text Text)) Text
- newDatabase :: Text -> Database
- data Datum = Datum' (Maybe Text)
- newDatum :: Datum
- data EncryptionConfiguration = EncryptionConfiguration' (Maybe Text) EncryptionOption
- newEncryptionConfiguration :: EncryptionOption -> EncryptionConfiguration
- data EngineConfiguration = EngineConfiguration' (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe Natural) Natural
- newEngineConfiguration :: Natural -> EngineConfiguration
- data EngineVersion = EngineVersion' (Maybe Text) (Maybe Text)
- newEngineVersion :: EngineVersion
- data ExecutorsSummary = ExecutorsSummary' (Maybe Integer) (Maybe ExecutorState) (Maybe ExecutorType) (Maybe Integer) (Maybe Integer) Text
- newExecutorsSummary :: Text -> ExecutorsSummary
- data FilterDefinition = FilterDefinition' (Maybe Text)
- newFilterDefinition :: FilterDefinition
- data NamedQuery = NamedQuery' (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text
- newNamedQuery :: Text -> Text -> Text -> NamedQuery
- data NotebookMetadata = NotebookMetadata' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe NotebookType) (Maybe Text)
- newNotebookMetadata :: NotebookMetadata
- data NotebookSessionSummary = NotebookSessionSummary' (Maybe POSIX) (Maybe Text)
- newNotebookSessionSummary :: NotebookSessionSummary
- data PreparedStatement = PreparedStatement' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newPreparedStatement :: PreparedStatement
- data PreparedStatementSummary = PreparedStatementSummary' (Maybe POSIX) (Maybe Text)
- newPreparedStatementSummary :: PreparedStatementSummary
- data QueryExecution = QueryExecution' (Maybe EngineVersion) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe QueryExecutionContext) (Maybe Text) (Maybe ResultConfiguration) (Maybe ResultReuseConfiguration) (Maybe StatementType) (Maybe QueryExecutionStatistics) (Maybe QueryExecutionStatus) (Maybe Text)
- newQueryExecution :: QueryExecution
- data QueryExecutionContext = QueryExecutionContext' (Maybe Text) (Maybe Text)
- newQueryExecutionContext :: QueryExecutionContext
- data QueryExecutionStatistics = QueryExecutionStatistics' (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe ResultReuseInformation) (Maybe Integer) (Maybe Integer)
- newQueryExecutionStatistics :: QueryExecutionStatistics
- data QueryExecutionStatus = QueryExecutionStatus' (Maybe AthenaError) (Maybe POSIX) (Maybe QueryExecutionState) (Maybe Text) (Maybe POSIX)
- newQueryExecutionStatus :: QueryExecutionStatus
- data QueryRuntimeStatistics = QueryRuntimeStatistics' (Maybe QueryStage) (Maybe QueryRuntimeStatisticsRows) (Maybe QueryRuntimeStatisticsTimeline)
- newQueryRuntimeStatistics :: QueryRuntimeStatistics
- data QueryRuntimeStatisticsRows = QueryRuntimeStatisticsRows' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newQueryRuntimeStatisticsRows :: QueryRuntimeStatisticsRows
- data QueryRuntimeStatisticsTimeline = QueryRuntimeStatisticsTimeline' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newQueryRuntimeStatisticsTimeline :: QueryRuntimeStatisticsTimeline
- data QueryStage = QueryStage' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe QueryStagePlanNode) (Maybe Integer) (Maybe Text) (Maybe [QueryStage])
- newQueryStage :: QueryStage
- data QueryStagePlanNode = QueryStagePlanNode' (Maybe [QueryStagePlanNode]) (Maybe Text) (Maybe Text) (Maybe [Text])
- newQueryStagePlanNode :: QueryStagePlanNode
- data ResultConfiguration = ResultConfiguration' (Maybe AclConfiguration) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text)
- newResultConfiguration :: ResultConfiguration
- data ResultConfigurationUpdates = ResultConfigurationUpdates' (Maybe AclConfiguration) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newResultConfigurationUpdates :: ResultConfigurationUpdates
- data ResultReuseByAgeConfiguration = ResultReuseByAgeConfiguration' (Maybe Natural) Bool
- newResultReuseByAgeConfiguration :: Bool -> ResultReuseByAgeConfiguration
- data ResultReuseConfiguration = ResultReuseConfiguration' (Maybe ResultReuseByAgeConfiguration)
- newResultReuseConfiguration :: ResultReuseConfiguration
- data ResultReuseInformation = ResultReuseInformation' Bool
- newResultReuseInformation :: Bool -> ResultReuseInformation
- data ResultSet = ResultSet' (Maybe ResultSetMetadata) (Maybe [Row])
- newResultSet :: ResultSet
- data ResultSetMetadata = ResultSetMetadata' (Maybe [ColumnInfo])
- newResultSetMetadata :: ResultSetMetadata
- data Row = Row' (Maybe [Datum])
- newRow :: Row
- data SessionConfiguration = SessionConfiguration' (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Integer) (Maybe Text)
- newSessionConfiguration :: SessionConfiguration
- data SessionStatistics = SessionStatistics' (Maybe Integer)
- newSessionStatistics :: SessionStatistics
- data SessionStatus = SessionStatus' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe SessionState) (Maybe Text)
- newSessionStatus :: SessionStatus
- data SessionSummary = SessionSummary' (Maybe Text) (Maybe EngineVersion) (Maybe Text) (Maybe Text) (Maybe SessionStatus)
- newSessionSummary :: SessionSummary
- data TableMetadata = TableMetadata' (Maybe [Column]) (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap Text Text)) (Maybe [Column]) (Maybe Text) Text
- newTableMetadata :: Text -> TableMetadata
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data UnprocessedNamedQueryId = UnprocessedNamedQueryId' (Maybe Text) (Maybe Text) (Maybe Text)
- newUnprocessedNamedQueryId :: UnprocessedNamedQueryId
- data UnprocessedPreparedStatementName = UnprocessedPreparedStatementName' (Maybe Text) (Maybe Text) (Maybe Text)
- newUnprocessedPreparedStatementName :: UnprocessedPreparedStatementName
- data UnprocessedQueryExecutionId = UnprocessedQueryExecutionId' (Maybe Text) (Maybe Text) (Maybe Text)
- newUnprocessedQueryExecutionId :: UnprocessedQueryExecutionId
- data WorkGroup = WorkGroup' (Maybe WorkGroupConfiguration) (Maybe POSIX) (Maybe Text) (Maybe WorkGroupState) Text
- newWorkGroup :: Text -> WorkGroup
- data WorkGroupConfiguration = WorkGroupConfiguration' (Maybe Text) (Maybe Natural) (Maybe CustomerContentEncryptionConfiguration) (Maybe Bool) (Maybe EngineVersion) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe ResultConfiguration)
- newWorkGroupConfiguration :: WorkGroupConfiguration
- data WorkGroupConfigurationUpdates = WorkGroupConfigurationUpdates' (Maybe Text) (Maybe Natural) (Maybe CustomerContentEncryptionConfiguration) (Maybe Bool) (Maybe EngineVersion) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe ResultConfigurationUpdates)
- newWorkGroupConfigurationUpdates :: WorkGroupConfigurationUpdates
- data WorkGroupSummary = WorkGroupSummary' (Maybe POSIX) (Maybe Text) (Maybe EngineVersion) (Maybe Text) (Maybe WorkGroupState)
- newWorkGroupSummary :: WorkGroupSummary
Service Configuration
defaultService :: Service Source #
API version 2017-05-18
of the Amazon Athena SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Athena
.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Indicates a platform issue, which may be due to a transient condition or outage.
InvalidRequestException
_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
_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
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A resource, such as a workgroup, was not found.
SessionAlreadyExistsException
_SessionAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified session already exists.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
Indicates that the request was throttled.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchGetNamedQuery
data BatchGetNamedQuery Source #
Contains an array of named query IDs.
See: newBatchGetNamedQuery
smart constructor.
Instances
newBatchGetNamedQuery Source #
Create a value of BatchGetNamedQuery
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:namedQueryIds:BatchGetNamedQuery'
, batchGetNamedQuery_namedQueryIds
- An array of query IDs.
data BatchGetNamedQueryResponse Source #
See: newBatchGetNamedQueryResponse
smart constructor.
Instances
newBatchGetNamedQueryResponse Source #
Create a value of BatchGetNamedQueryResponse
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:namedQueries:BatchGetNamedQueryResponse'
, batchGetNamedQueryResponse_namedQueries
- Information about the named query IDs submitted.
$sel:unprocessedNamedQueryIds:BatchGetNamedQueryResponse'
, batchGetNamedQueryResponse_unprocessedNamedQueryIds
- Information about provided query IDs.
$sel:httpStatus:BatchGetNamedQueryResponse'
, batchGetNamedQueryResponse_httpStatus
- The response's http status code.
BatchGetPreparedStatement
data BatchGetPreparedStatement Source #
See: newBatchGetPreparedStatement
smart constructor.
Instances
newBatchGetPreparedStatement Source #
Create a value of BatchGetPreparedStatement
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:preparedStatementNames:BatchGetPreparedStatement'
, batchGetPreparedStatement_preparedStatementNames
- A list of prepared statement names to return.
BatchGetPreparedStatement
, batchGetPreparedStatement_workGroup
- The name of the workgroup to which the prepared statements belong.
data BatchGetPreparedStatementResponse Source #
See: newBatchGetPreparedStatementResponse
smart constructor.
BatchGetPreparedStatementResponse' (Maybe [PreparedStatement]) (Maybe [UnprocessedPreparedStatementName]) Int |
Instances
newBatchGetPreparedStatementResponse Source #
Create a value of BatchGetPreparedStatementResponse
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:preparedStatements:BatchGetPreparedStatementResponse'
, batchGetPreparedStatementResponse_preparedStatements
- The list of prepared statements returned.
$sel:unprocessedPreparedStatementNames:BatchGetPreparedStatementResponse'
, batchGetPreparedStatementResponse_unprocessedPreparedStatementNames
- A list of one or more prepared statements that were requested but could
not be returned.
$sel:httpStatus:BatchGetPreparedStatementResponse'
, batchGetPreparedStatementResponse_httpStatus
- The response's http status code.
BatchGetQueryExecution
data BatchGetQueryExecution Source #
Contains an array of query execution IDs.
See: newBatchGetQueryExecution
smart constructor.
Instances
newBatchGetQueryExecution Source #
Create a value of BatchGetQueryExecution
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:queryExecutionIds:BatchGetQueryExecution'
, batchGetQueryExecution_queryExecutionIds
- An array of query execution IDs.
data BatchGetQueryExecutionResponse Source #
See: newBatchGetQueryExecutionResponse
smart constructor.
Instances
newBatchGetQueryExecutionResponse Source #
Create a value of BatchGetQueryExecutionResponse
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:queryExecutions:BatchGetQueryExecutionResponse'
, batchGetQueryExecutionResponse_queryExecutions
- Information about a query execution.
$sel:unprocessedQueryExecutionIds:BatchGetQueryExecutionResponse'
, batchGetQueryExecutionResponse_unprocessedQueryExecutionIds
- Information about the query executions that failed to run.
$sel:httpStatus:BatchGetQueryExecutionResponse'
, batchGetQueryExecutionResponse_httpStatus
- The response's http status code.
CreateDataCatalog
data CreateDataCatalog Source #
See: newCreateDataCatalog
smart constructor.
Instances
Create a value of CreateDataCatalog
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:
CreateDataCatalog
, createDataCatalog_description
- A description of the data catalog to be created.
CreateDataCatalog
, createDataCatalog_parameters
- Specifies the Lambda function or functions to use for creating the data
catalog. This is a mapping whose values depend on the catalog type.
For the
HIVE
data catalog type, use the following syntax. Themetadata-function
parameter is required.The sdk-version
parameter is optional and defaults to the currently supported version.metadata-function=
lambda_arn
, sdk-version=
version_number
For the
LAMBDA
data catalog type, use one of the following sets of required parameters, but not both.If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=
lambda_arn
, record-function=
lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=
lambda_arn
The
GLUE
type takes a catalog ID parameter and is required. Thecatalog_id
catalog-id=
catalog_id
- The
GLUE
data catalog type also applies to the defaultAwsDataCatalog
that already exists in your account, of which you can have only one and cannot modify. - Queries that specify a Glue Data Catalog other than the default
AwsDataCatalog
must be run on Athena engine version 2. - In Regions where Athena engine version 2 is not available,
creating new Glue data catalogs results in an
INVALID_INPUT
error.
- The
$sel:tags:CreateDataCatalog'
, createDataCatalog_tags
- A list of comma separated tags to add to the data catalog that is
created.
CreateDataCatalog
, createDataCatalog_name
- The name of the data catalog to create. The catalog name must be unique
for the Amazon Web Services account and can use a maximum of 127
alphanumeric, underscore, at sign, or hyphen characters. The remainder
of the length constraint of 256 is reserved for use by Athena.
CreateDataCatalog
, createDataCatalog_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.
data CreateDataCatalogResponse Source #
See: newCreateDataCatalogResponse
smart constructor.
Instances
newCreateDataCatalogResponse Source #
Create a value of CreateDataCatalogResponse
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:httpStatus:CreateDataCatalogResponse'
, createDataCatalogResponse_httpStatus
- The response's http status code.
CreateNamedQuery
data CreateNamedQuery Source #
See: newCreateNamedQuery
smart constructor.
Instances
Create a value of CreateNamedQuery
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:clientRequestToken:CreateNamedQuery'
, createNamedQuery_clientRequestToken
- A unique case-sensitive string used to ensure the request to create the
query is idempotent (executes only once). If another CreateNamedQuery
request is received, the same response is returned and another query is
not created. If a parameter has changed, for example, the QueryString
,
an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
CreateNamedQuery
, createNamedQuery_description
- The query description.
CreateNamedQuery
, createNamedQuery_workGroup
- The name of the workgroup in which the named query is being created.
CreateNamedQuery
, createNamedQuery_name
- The query name.
CreateNamedQuery
, createNamedQuery_database
- The database to which the query belongs.
CreateNamedQuery
, createNamedQuery_queryString
- The contents of the query with all query statements.
data CreateNamedQueryResponse Source #
See: newCreateNamedQueryResponse
smart constructor.
Instances
newCreateNamedQueryResponse Source #
Create a value of CreateNamedQueryResponse
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:
CreateNamedQueryResponse
, createNamedQueryResponse_namedQueryId
- The unique ID of the query.
$sel:httpStatus:CreateNamedQueryResponse'
, createNamedQueryResponse_httpStatus
- The response's http status code.
CreateNotebook
data CreateNotebook Source #
See: newCreateNotebook
smart constructor.
Instances
Create a value of CreateNotebook
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:clientRequestToken:CreateNotebook'
, createNotebook_clientRequestToken
- A unique case-sensitive string used to ensure the request to create the
notebook is idempotent (executes only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
CreateNotebook
, createNotebook_workGroup
- The name of the Spark enabled workgroup in which the notebook will be
created.
CreateNotebook
, createNotebook_name
- The name of the ipynb
file to be created in the Spark workgroup,
without the .ipynb
extension.
data CreateNotebookResponse Source #
See: newCreateNotebookResponse
smart constructor.
Instances
newCreateNotebookResponse Source #
Create a value of CreateNotebookResponse
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:
CreateNotebookResponse
, createNotebookResponse_notebookId
- A unique identifier for the notebook.
$sel:httpStatus:CreateNotebookResponse'
, createNotebookResponse_httpStatus
- The response's http status code.
CreatePreparedStatement
data CreatePreparedStatement Source #
See: newCreatePreparedStatement
smart constructor.
Instances
newCreatePreparedStatement Source #
:: Text | |
-> Text | |
-> Text | |
-> CreatePreparedStatement |
Create a value of CreatePreparedStatement
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:
CreatePreparedStatement
, createPreparedStatement_description
- The description of the prepared statement.
CreatePreparedStatement
, createPreparedStatement_statementName
- The name of the prepared statement.
CreatePreparedStatement
, createPreparedStatement_workGroup
- The name of the workgroup to which the prepared statement belongs.
CreatePreparedStatement
, createPreparedStatement_queryStatement
- The query string for the prepared statement.
data CreatePreparedStatementResponse Source #
See: newCreatePreparedStatementResponse
smart constructor.
Instances
Generic CreatePreparedStatementResponse Source # | |
Read CreatePreparedStatementResponse Source # | |
Show CreatePreparedStatementResponse Source # | |
Defined in Amazonka.Athena.CreatePreparedStatement | |
NFData CreatePreparedStatementResponse Source # | |
Defined in Amazonka.Athena.CreatePreparedStatement rnf :: CreatePreparedStatementResponse -> () # | |
Eq CreatePreparedStatementResponse Source # | |
type Rep CreatePreparedStatementResponse Source # | |
Defined in Amazonka.Athena.CreatePreparedStatement type Rep CreatePreparedStatementResponse = D1 ('MetaData "CreatePreparedStatementResponse" "Amazonka.Athena.CreatePreparedStatement" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CreatePreparedStatementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreatePreparedStatementResponse Source #
Create a value of CreatePreparedStatementResponse
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:httpStatus:CreatePreparedStatementResponse'
, createPreparedStatementResponse_httpStatus
- The response's http status code.
CreatePresignedNotebookUrl
data CreatePresignedNotebookUrl Source #
See: newCreatePresignedNotebookUrl
smart constructor.
Instances
newCreatePresignedNotebookUrl Source #
Create a value of CreatePresignedNotebookUrl
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:
CreatePresignedNotebookUrl
, createPresignedNotebookUrl_sessionId
- The session ID.
data CreatePresignedNotebookUrlResponse Source #
See: newCreatePresignedNotebookUrlResponse
smart constructor.
Instances
newCreatePresignedNotebookUrlResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Integer |
|
-> CreatePresignedNotebookUrlResponse |
Create a value of CreatePresignedNotebookUrlResponse
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:httpStatus:CreatePresignedNotebookUrlResponse'
, createPresignedNotebookUrlResponse_httpStatus
- The response's http status code.
$sel:notebookUrl:CreatePresignedNotebookUrlResponse'
, createPresignedNotebookUrlResponse_notebookUrl
- The URL of the notebook. The URL includes the authentication token and
notebook file name and points directly to the opened notebook.
$sel:authToken:CreatePresignedNotebookUrlResponse'
, createPresignedNotebookUrlResponse_authToken
- The authentication token for the notebook.
$sel:authTokenExpirationTime:CreatePresignedNotebookUrlResponse'
, createPresignedNotebookUrlResponse_authTokenExpirationTime
- The UTC epoch time when the authentication token expires.
CreateWorkGroup
data CreateWorkGroup Source #
See: newCreateWorkGroup
smart constructor.
Instances
Create a value of CreateWorkGroup
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:
CreateWorkGroup
, createWorkGroup_configuration
- Contains configuration information for creating an Athena SQL workgroup,
which includes the location in Amazon S3 where query results are stored,
the encryption configuration, if any, used for encrypting query results,
whether the Amazon CloudWatch Metrics are enabled for the workgroup, the
limit for the amount of bytes scanned (cutoff) per query, if it is
specified, and whether workgroup's settings (specified with
EnforceWorkGroupConfiguration
) in the WorkGroupConfiguration
override client-side settings. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
CreateWorkGroup
, createWorkGroup_description
- The workgroup description.
$sel:tags:CreateWorkGroup'
, createWorkGroup_tags
- A list of comma separated tags to add to the workgroup that is created.
CreateWorkGroup
, createWorkGroup_name
- The workgroup name.
data CreateWorkGroupResponse Source #
See: newCreateWorkGroupResponse
smart constructor.
Instances
newCreateWorkGroupResponse Source #
Create a value of CreateWorkGroupResponse
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:httpStatus:CreateWorkGroupResponse'
, createWorkGroupResponse_httpStatus
- The response's http status code.
DeleteDataCatalog
data DeleteDataCatalog Source #
See: newDeleteDataCatalog
smart constructor.
Instances
Create a value of DeleteDataCatalog
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:
DeleteDataCatalog
, deleteDataCatalog_name
- The name of the data catalog to delete.
data DeleteDataCatalogResponse Source #
See: newDeleteDataCatalogResponse
smart constructor.
Instances
newDeleteDataCatalogResponse Source #
Create a value of DeleteDataCatalogResponse
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:httpStatus:DeleteDataCatalogResponse'
, deleteDataCatalogResponse_httpStatus
- The response's http status code.
DeleteNamedQuery
data DeleteNamedQuery Source #
See: newDeleteNamedQuery
smart constructor.
Instances
Create a value of DeleteNamedQuery
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:
DeleteNamedQuery
, deleteNamedQuery_namedQueryId
- The unique ID of the query to delete.
data DeleteNamedQueryResponse Source #
See: newDeleteNamedQueryResponse
smart constructor.
Instances
newDeleteNamedQueryResponse Source #
Create a value of DeleteNamedQueryResponse
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:httpStatus:DeleteNamedQueryResponse'
, deleteNamedQueryResponse_httpStatus
- The response's http status code.
DeleteNotebook
data DeleteNotebook Source #
See: newDeleteNotebook
smart constructor.
Instances
Create a value of DeleteNotebook
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:
DeleteNotebook
, deleteNotebook_notebookId
- The ID of the notebook to delete.
data DeleteNotebookResponse Source #
See: newDeleteNotebookResponse
smart constructor.
Instances
Generic DeleteNotebookResponse Source # | |
Defined in Amazonka.Athena.DeleteNotebook type Rep DeleteNotebookResponse :: Type -> Type # | |
Read DeleteNotebookResponse Source # | |
Show DeleteNotebookResponse Source # | |
Defined in Amazonka.Athena.DeleteNotebook showsPrec :: Int -> DeleteNotebookResponse -> ShowS # show :: DeleteNotebookResponse -> String # showList :: [DeleteNotebookResponse] -> ShowS # | |
NFData DeleteNotebookResponse Source # | |
Defined in Amazonka.Athena.DeleteNotebook rnf :: DeleteNotebookResponse -> () # | |
Eq DeleteNotebookResponse Source # | |
Defined in Amazonka.Athena.DeleteNotebook | |
type Rep DeleteNotebookResponse Source # | |
Defined in Amazonka.Athena.DeleteNotebook type Rep DeleteNotebookResponse = D1 ('MetaData "DeleteNotebookResponse" "Amazonka.Athena.DeleteNotebook" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "DeleteNotebookResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteNotebookResponse Source #
Create a value of DeleteNotebookResponse
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:httpStatus:DeleteNotebookResponse'
, deleteNotebookResponse_httpStatus
- The response's http status code.
DeletePreparedStatement
data DeletePreparedStatement Source #
See: newDeletePreparedStatement
smart constructor.
Instances
newDeletePreparedStatement Source #
Create a value of DeletePreparedStatement
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:
DeletePreparedStatement
, deletePreparedStatement_statementName
- The name of the prepared statement to delete.
DeletePreparedStatement
, deletePreparedStatement_workGroup
- The workgroup to which the statement to be deleted belongs.
data DeletePreparedStatementResponse Source #
See: newDeletePreparedStatementResponse
smart constructor.
Instances
Generic DeletePreparedStatementResponse Source # | |
Read DeletePreparedStatementResponse Source # | |
Show DeletePreparedStatementResponse Source # | |
Defined in Amazonka.Athena.DeletePreparedStatement | |
NFData DeletePreparedStatementResponse Source # | |
Defined in Amazonka.Athena.DeletePreparedStatement rnf :: DeletePreparedStatementResponse -> () # | |
Eq DeletePreparedStatementResponse Source # | |
type Rep DeletePreparedStatementResponse Source # | |
Defined in Amazonka.Athena.DeletePreparedStatement type Rep DeletePreparedStatementResponse = D1 ('MetaData "DeletePreparedStatementResponse" "Amazonka.Athena.DeletePreparedStatement" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "DeletePreparedStatementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeletePreparedStatementResponse Source #
Create a value of DeletePreparedStatementResponse
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:httpStatus:DeletePreparedStatementResponse'
, deletePreparedStatementResponse_httpStatus
- The response's http status code.
DeleteWorkGroup
data DeleteWorkGroup Source #
See: newDeleteWorkGroup
smart constructor.
Instances
Create a value of DeleteWorkGroup
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:recursiveDeleteOption:DeleteWorkGroup'
, deleteWorkGroup_recursiveDeleteOption
- The option to delete the workgroup and its contents even if the
workgroup contains any named queries or query executions.
DeleteWorkGroup
, deleteWorkGroup_workGroup
- The unique name of the workgroup to delete.
data DeleteWorkGroupResponse Source #
See: newDeleteWorkGroupResponse
smart constructor.
Instances
newDeleteWorkGroupResponse Source #
Create a value of DeleteWorkGroupResponse
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:httpStatus:DeleteWorkGroupResponse'
, deleteWorkGroupResponse_httpStatus
- The response's http status code.
ExportNotebook
data ExportNotebook Source #
See: newExportNotebook
smart constructor.
Instances
Create a value of ExportNotebook
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:
ExportNotebook
, exportNotebook_notebookId
- The ID of the notebook to export.
data ExportNotebookResponse Source #
See: newExportNotebookResponse
smart constructor.
Instances
newExportNotebookResponse Source #
Create a value of ExportNotebookResponse
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:notebookMetadata:ExportNotebookResponse'
, exportNotebookResponse_notebookMetadata
- The notebook metadata, including notebook ID, notebook name, and
workgroup name.
$sel:payload:ExportNotebookResponse'
, exportNotebookResponse_payload
- The content of the exported notebook.
$sel:httpStatus:ExportNotebookResponse'
, exportNotebookResponse_httpStatus
- The response's http status code.
GetCalculationExecution
data GetCalculationExecution Source #
See: newGetCalculationExecution
smart constructor.
Instances
newGetCalculationExecution Source #
Create a value of GetCalculationExecution
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:
GetCalculationExecution
, getCalculationExecution_calculationExecutionId
- The calculation execution UUID.
data GetCalculationExecutionResponse Source #
See: newGetCalculationExecutionResponse
smart constructor.
GetCalculationExecutionResponse' (Maybe Text) (Maybe Text) (Maybe CalculationResult) (Maybe Text) (Maybe CalculationStatistics) (Maybe CalculationStatus) (Maybe Text) Int |
Instances
newGetCalculationExecutionResponse Source #
Create a value of GetCalculationExecutionResponse
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:
GetCalculationExecution
, getCalculationExecutionResponse_calculationExecutionId
- The calculation execution UUID.
GetCalculationExecutionResponse
, getCalculationExecutionResponse_description
- The description of the calculation execution.
$sel:result:GetCalculationExecutionResponse'
, getCalculationExecutionResponse_result
- Contains result information. This field is populated only if the
calculation is completed.
GetCalculationExecutionResponse
, getCalculationExecutionResponse_sessionId
- The session ID that the calculation ran in.
GetCalculationExecutionResponse
, getCalculationExecutionResponse_statistics
- Contains information about the data processing unit (DPU) execution time
and progress. This field is populated only when statistics are
available.
GetCalculationExecutionResponse
, getCalculationExecutionResponse_status
- Contains information about the status of the calculation.
GetCalculationExecutionResponse
, getCalculationExecutionResponse_workingDirectory
- The Amazon S3 location in which calculation results are stored.
$sel:httpStatus:GetCalculationExecutionResponse'
, getCalculationExecutionResponse_httpStatus
- The response's http status code.
GetCalculationExecutionCode
data GetCalculationExecutionCode Source #
See: newGetCalculationExecutionCode
smart constructor.
Instances
newGetCalculationExecutionCode Source #
Create a value of GetCalculationExecutionCode
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:
GetCalculationExecutionCode
, getCalculationExecutionCode_calculationExecutionId
- The calculation execution UUID.
data GetCalculationExecutionCodeResponse Source #
See: newGetCalculationExecutionCodeResponse
smart constructor.
Instances
Generic GetCalculationExecutionCodeResponse Source # | |
Read GetCalculationExecutionCodeResponse Source # | |
Show GetCalculationExecutionCodeResponse Source # | |
NFData GetCalculationExecutionCodeResponse Source # | |
Defined in Amazonka.Athena.GetCalculationExecutionCode rnf :: GetCalculationExecutionCodeResponse -> () # | |
Eq GetCalculationExecutionCodeResponse Source # | |
type Rep GetCalculationExecutionCodeResponse Source # | |
Defined in Amazonka.Athena.GetCalculationExecutionCode type Rep GetCalculationExecutionCodeResponse = D1 ('MetaData "GetCalculationExecutionCodeResponse" "Amazonka.Athena.GetCalculationExecutionCode" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "GetCalculationExecutionCodeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "codeBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newGetCalculationExecutionCodeResponse Source #
Create a value of GetCalculationExecutionCodeResponse
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:
GetCalculationExecutionCodeResponse
, getCalculationExecutionCodeResponse_codeBlock
- A pre-signed URL to the code that executed the calculation.
$sel:httpStatus:GetCalculationExecutionCodeResponse'
, getCalculationExecutionCodeResponse_httpStatus
- The response's http status code.
GetCalculationExecutionStatus
data GetCalculationExecutionStatus Source #
See: newGetCalculationExecutionStatus
smart constructor.
Instances
newGetCalculationExecutionStatus Source #
Create a value of GetCalculationExecutionStatus
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:
GetCalculationExecutionStatus
, getCalculationExecutionStatus_calculationExecutionId
- The calculation execution UUID.
data GetCalculationExecutionStatusResponse Source #
See: newGetCalculationExecutionStatusResponse
smart constructor.
Instances
newGetCalculationExecutionStatusResponse Source #
Create a value of GetCalculationExecutionStatusResponse
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:
GetCalculationExecutionStatusResponse
, getCalculationExecutionStatusResponse_statistics
- Contains information about the DPU execution time and progress.
GetCalculationExecutionStatusResponse
, getCalculationExecutionStatusResponse_status
- Contains information about the calculation execution status.
$sel:httpStatus:GetCalculationExecutionStatusResponse'
, getCalculationExecutionStatusResponse_httpStatus
- The response's http status code.
GetDataCatalog
data GetDataCatalog Source #
See: newGetDataCatalog
smart constructor.
Instances
Create a value of GetDataCatalog
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:
GetDataCatalog
, getDataCatalog_name
- The name of the data catalog to return.
data GetDataCatalogResponse Source #
See: newGetDataCatalogResponse
smart constructor.
Instances
newGetDataCatalogResponse Source #
Create a value of GetDataCatalogResponse
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:dataCatalog:GetDataCatalogResponse'
, getDataCatalogResponse_dataCatalog
- The data catalog returned.
$sel:httpStatus:GetDataCatalogResponse'
, getDataCatalogResponse_httpStatus
- The response's http status code.
GetDatabase
data GetDatabase Source #
See: newGetDatabase
smart constructor.
Instances
Create a value of GetDatabase
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:
GetDatabase
, getDatabase_catalogName
- The name of the data catalog that contains the database to return.
$sel:databaseName:GetDatabase'
, getDatabase_databaseName
- The name of the database to return.
data GetDatabaseResponse Source #
See: newGetDatabaseResponse
smart constructor.
Instances
newGetDatabaseResponse Source #
Create a value of GetDatabaseResponse
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:
GetDatabaseResponse
, getDatabaseResponse_database
- The database returned.
$sel:httpStatus:GetDatabaseResponse'
, getDatabaseResponse_httpStatus
- The response's http status code.
GetNamedQuery
data GetNamedQuery Source #
See: newGetNamedQuery
smart constructor.
Instances
Create a value of GetNamedQuery
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:
GetNamedQuery
, getNamedQuery_namedQueryId
- The unique ID of the query. Use ListNamedQueries to get query IDs.
data GetNamedQueryResponse Source #
See: newGetNamedQueryResponse
smart constructor.
Instances
newGetNamedQueryResponse Source #
Create a value of GetNamedQueryResponse
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:namedQuery:GetNamedQueryResponse'
, getNamedQueryResponse_namedQuery
- Information about the query.
$sel:httpStatus:GetNamedQueryResponse'
, getNamedQueryResponse_httpStatus
- The response's http status code.
GetNotebookMetadata
data GetNotebookMetadata Source #
See: newGetNotebookMetadata
smart constructor.
Instances
newGetNotebookMetadata Source #
Create a value of GetNotebookMetadata
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:
GetNotebookMetadata
, getNotebookMetadata_notebookId
- The ID of the notebook whose metadata is to be retrieved.
data GetNotebookMetadataResponse Source #
See: newGetNotebookMetadataResponse
smart constructor.
Instances
newGetNotebookMetadataResponse Source #
Create a value of GetNotebookMetadataResponse
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:notebookMetadata:GetNotebookMetadataResponse'
, getNotebookMetadataResponse_notebookMetadata
- The metadata that is returned for the specified notebook ID.
$sel:httpStatus:GetNotebookMetadataResponse'
, getNotebookMetadataResponse_httpStatus
- The response's http status code.
GetPreparedStatement
data GetPreparedStatement Source #
See: newGetPreparedStatement
smart constructor.
Instances
newGetPreparedStatement Source #
Create a value of GetPreparedStatement
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:
GetPreparedStatement
, getPreparedStatement_statementName
- The name of the prepared statement to retrieve.
GetPreparedStatement
, getPreparedStatement_workGroup
- The workgroup to which the statement to be retrieved belongs.
data GetPreparedStatementResponse Source #
See: newGetPreparedStatementResponse
smart constructor.
Instances
newGetPreparedStatementResponse Source #
Create a value of GetPreparedStatementResponse
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:preparedStatement:GetPreparedStatementResponse'
, getPreparedStatementResponse_preparedStatement
- The name of the prepared statement that was retrieved.
$sel:httpStatus:GetPreparedStatementResponse'
, getPreparedStatementResponse_httpStatus
- The response's http status code.
GetQueryExecution
data GetQueryExecution Source #
See: newGetQueryExecution
smart constructor.
Instances
Create a value of GetQueryExecution
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:
GetQueryExecution
, getQueryExecution_queryExecutionId
- The unique ID of the query execution.
data GetQueryExecutionResponse Source #
See: newGetQueryExecutionResponse
smart constructor.
Instances
newGetQueryExecutionResponse Source #
Create a value of GetQueryExecutionResponse
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:queryExecution:GetQueryExecutionResponse'
, getQueryExecutionResponse_queryExecution
- Information about the query execution.
$sel:httpStatus:GetQueryExecutionResponse'
, getQueryExecutionResponse_httpStatus
- The response's http status code.
GetQueryResults (Paginated)
data GetQueryResults Source #
See: newGetQueryResults
smart constructor.
Instances
Create a value of GetQueryResults
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:maxResults:GetQueryResults'
, getQueryResults_maxResults
- The maximum number of results (rows) to return in this request.
GetQueryResults
, getQueryResults_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
GetQueryResults
, getQueryResults_queryExecutionId
- The unique ID of the query execution.
data GetQueryResultsResponse Source #
See: newGetQueryResultsResponse
smart constructor.
Instances
newGetQueryResultsResponse Source #
Create a value of GetQueryResultsResponse
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:
GetQueryResults
, getQueryResultsResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:resultSet:GetQueryResultsResponse'
, getQueryResultsResponse_resultSet
- The results of the query execution.
$sel:updateCount:GetQueryResultsResponse'
, getQueryResultsResponse_updateCount
- The number of rows inserted with a CREATE TABLE AS SELECT
statement.
$sel:httpStatus:GetQueryResultsResponse'
, getQueryResultsResponse_httpStatus
- The response's http status code.
GetQueryRuntimeStatistics
data GetQueryRuntimeStatistics Source #
See: newGetQueryRuntimeStatistics
smart constructor.
Instances
newGetQueryRuntimeStatistics Source #
Create a value of GetQueryRuntimeStatistics
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:
GetQueryRuntimeStatistics
, getQueryRuntimeStatistics_queryExecutionId
- The unique ID of the query execution.
data GetQueryRuntimeStatisticsResponse Source #
See: newGetQueryRuntimeStatisticsResponse
smart constructor.
Instances
Generic GetQueryRuntimeStatisticsResponse Source # | |
Read GetQueryRuntimeStatisticsResponse Source # | |
Show GetQueryRuntimeStatisticsResponse Source # | |
NFData GetQueryRuntimeStatisticsResponse Source # | |
Defined in Amazonka.Athena.GetQueryRuntimeStatistics rnf :: GetQueryRuntimeStatisticsResponse -> () # | |
Eq GetQueryRuntimeStatisticsResponse Source # | |
type Rep GetQueryRuntimeStatisticsResponse Source # | |
Defined in Amazonka.Athena.GetQueryRuntimeStatistics type Rep GetQueryRuntimeStatisticsResponse = D1 ('MetaData "GetQueryRuntimeStatisticsResponse" "Amazonka.Athena.GetQueryRuntimeStatistics" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "GetQueryRuntimeStatisticsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryRuntimeStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryRuntimeStatistics)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newGetQueryRuntimeStatisticsResponse Source #
Create a value of GetQueryRuntimeStatisticsResponse
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:queryRuntimeStatistics:GetQueryRuntimeStatisticsResponse'
, getQueryRuntimeStatisticsResponse_queryRuntimeStatistics
- Runtime statistics about the query execution.
$sel:httpStatus:GetQueryRuntimeStatisticsResponse'
, getQueryRuntimeStatisticsResponse_httpStatus
- The response's http status code.
GetSession
data GetSession Source #
See: newGetSession
smart constructor.
Instances
:: Text | |
-> GetSession |
Create a value of GetSession
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:
GetSession
, getSession_sessionId
- The session ID.
data GetSessionResponse Source #
See: newGetSessionResponse
smart constructor.
GetSessionResponse' (Maybe Text) (Maybe EngineConfiguration) (Maybe Text) (Maybe Text) (Maybe SessionConfiguration) (Maybe Text) (Maybe SessionStatistics) (Maybe SessionStatus) (Maybe Text) Int |
Instances
newGetSessionResponse Source #
Create a value of GetSessionResponse
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:
GetSessionResponse
, getSessionResponse_description
- The session description.
$sel:engineConfiguration:GetSessionResponse'
, getSessionResponse_engineConfiguration
- Contains engine configuration information like DPU usage.
GetSessionResponse
, getSessionResponse_engineVersion
- The engine version used by the session (for example,
PySpark engine version 3
). You can get a list of engine versions by
calling ListEngineVersions.
GetSessionResponse
, getSessionResponse_notebookVersion
- The notebook version.
$sel:sessionConfiguration:GetSessionResponse'
, getSessionResponse_sessionConfiguration
- Contains the workgroup configuration information used by the session.
GetSession
, getSessionResponse_sessionId
- The session ID.
GetSessionResponse
, getSessionResponse_statistics
- Contains the DPU execution time.
GetSessionResponse
, getSessionResponse_status
- Contains information about the status of the session.
GetSessionResponse
, getSessionResponse_workGroup
- The workgroup to which the session belongs.
$sel:httpStatus:GetSessionResponse'
, getSessionResponse_httpStatus
- The response's http status code.
GetSessionStatus
data GetSessionStatus Source #
See: newGetSessionStatus
smart constructor.
Instances
Create a value of GetSessionStatus
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:
GetSessionStatus
, getSessionStatus_sessionId
- The session ID.
data GetSessionStatusResponse Source #
See: newGetSessionStatusResponse
smart constructor.
Instances
newGetSessionStatusResponse Source #
Create a value of GetSessionStatusResponse
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:
GetSessionStatus
, getSessionStatusResponse_sessionId
- The session ID.
GetSessionStatusResponse
, getSessionStatusResponse_status
- Contains information about the status of the session.
$sel:httpStatus:GetSessionStatusResponse'
, getSessionStatusResponse_httpStatus
- The response's http status code.
GetTableMetadata
data GetTableMetadata Source #
See: newGetTableMetadata
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> GetTableMetadata |
Create a value of GetTableMetadata
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:
GetTableMetadata
, getTableMetadata_catalogName
- The name of the data catalog that contains the database and table
metadata to return.
$sel:databaseName:GetTableMetadata'
, getTableMetadata_databaseName
- The name of the database that contains the table metadata to return.
GetTableMetadata
, getTableMetadata_tableName
- The name of the table for which metadata is returned.
data GetTableMetadataResponse Source #
See: newGetTableMetadataResponse
smart constructor.
Instances
newGetTableMetadataResponse Source #
Create a value of GetTableMetadataResponse
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:tableMetadata:GetTableMetadataResponse'
, getTableMetadataResponse_tableMetadata
- An object that contains table metadata.
$sel:httpStatus:GetTableMetadataResponse'
, getTableMetadataResponse_httpStatus
- The response's http status code.
GetWorkGroup
data GetWorkGroup Source #
See: newGetWorkGroup
smart constructor.
Instances
Create a value of GetWorkGroup
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:
GetWorkGroup
, getWorkGroup_workGroup
- The name of the workgroup.
data GetWorkGroupResponse Source #
See: newGetWorkGroupResponse
smart constructor.
Instances
newGetWorkGroupResponse Source #
Create a value of GetWorkGroupResponse
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:
GetWorkGroup
, getWorkGroupResponse_workGroup
- Information about the workgroup.
$sel:httpStatus:GetWorkGroupResponse'
, getWorkGroupResponse_httpStatus
- The response's http status code.
ImportNotebook
data ImportNotebook Source #
See: newImportNotebook
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> NotebookType | |
-> ImportNotebook |
Create a value of ImportNotebook
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:clientRequestToken:ImportNotebook'
, importNotebook_clientRequestToken
- A unique case-sensitive string used to ensure the request to import the
notebook is idempotent (executes only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
ImportNotebook
, importNotebook_workGroup
- The name of the Spark enabled workgroup to import the notebook to.
ImportNotebook
, importNotebook_name
- The name of the notebook to import.
$sel:payload:ImportNotebook'
, importNotebook_payload
- The notebook content to be imported.
ImportNotebook
, importNotebook_type
- The notebook content type. Currently, the only valid type is IPYNB
.
data ImportNotebookResponse Source #
See: newImportNotebookResponse
smart constructor.
Instances
newImportNotebookResponse Source #
Create a value of ImportNotebookResponse
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:
ImportNotebookResponse
, importNotebookResponse_notebookId
- The ID of the notebook to import.
$sel:httpStatus:ImportNotebookResponse'
, importNotebookResponse_httpStatus
- The response's http status code.
ListApplicationDPUSizes
data ListApplicationDPUSizes Source #
See: newListApplicationDPUSizes
smart constructor.
Instances
newListApplicationDPUSizes :: ListApplicationDPUSizes Source #
Create a value of ListApplicationDPUSizes
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:maxResults:ListApplicationDPUSizes'
, listApplicationDPUSizes_maxResults
- Specifies the maximum number of results to return.
ListApplicationDPUSizes
, listApplicationDPUSizes_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated.
data ListApplicationDPUSizesResponse Source #
See: newListApplicationDPUSizesResponse
smart constructor.
Instances
newListApplicationDPUSizesResponse Source #
Create a value of ListApplicationDPUSizesResponse
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:applicationDPUSizes:ListApplicationDPUSizesResponse'
, listApplicationDPUSizesResponse_applicationDPUSizes
- A list of the supported DPU sizes that the application runtime supports.
ListApplicationDPUSizes
, listApplicationDPUSizesResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:httpStatus:ListApplicationDPUSizesResponse'
, listApplicationDPUSizesResponse_httpStatus
- The response's http status code.
ListCalculationExecutions
data ListCalculationExecutions Source #
See: newListCalculationExecutions
smart constructor.
Instances
newListCalculationExecutions Source #
Create a value of ListCalculationExecutions
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:maxResults:ListCalculationExecutions'
, listCalculationExecutions_maxResults
- The maximum number of calculation executions to return.
ListCalculationExecutions
, listCalculationExecutions_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:stateFilter:ListCalculationExecutions'
, listCalculationExecutions_stateFilter
- A filter for a specific calculation execution state. A description of
each state follows.
CREATING
- The calculation is in the process of being created.
CREATED
- The calculation has been created and is ready to run.
QUEUED
- The calculation has been queued for processing.
RUNNING
- The calculation is running.
CANCELING
- A request to cancel the calculation has been received and
the system is working to stop it.
CANCELED
- The calculation is no longer running as the result of a
cancel request.
COMPLETED
- The calculation has completed without error.
FAILED
- The calculation failed and is no longer running.
ListCalculationExecutions
, listCalculationExecutions_sessionId
- The session ID.
data ListCalculationExecutionsResponse Source #
See: newListCalculationExecutionsResponse
smart constructor.
Instances
newListCalculationExecutionsResponse Source #
Create a value of ListCalculationExecutionsResponse
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:calculations:ListCalculationExecutionsResponse'
, listCalculationExecutionsResponse_calculations
- A list of CalculationSummary objects.
ListCalculationExecutions
, listCalculationExecutionsResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:httpStatus:ListCalculationExecutionsResponse'
, listCalculationExecutionsResponse_httpStatus
- The response's http status code.
ListDataCatalogs (Paginated)
data ListDataCatalogs Source #
See: newListDataCatalogs
smart constructor.
Instances
newListDataCatalogs :: ListDataCatalogs Source #
Create a value of ListDataCatalogs
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:maxResults:ListDataCatalogs'
, listDataCatalogs_maxResults
- Specifies the maximum number of data catalogs to return.
ListDataCatalogs
, listDataCatalogs_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the previous
page call.
data ListDataCatalogsResponse Source #
See: newListDataCatalogsResponse
smart constructor.
Instances
newListDataCatalogsResponse Source #
Create a value of ListDataCatalogsResponse
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:dataCatalogsSummary:ListDataCatalogsResponse'
, listDataCatalogsResponse_dataCatalogsSummary
- A summary list of data catalogs.
ListDataCatalogs
, listDataCatalogsResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the previous
page call.
$sel:httpStatus:ListDataCatalogsResponse'
, listDataCatalogsResponse_httpStatus
- The response's http status code.
ListDatabases (Paginated)
data ListDatabases Source #
See: newListDatabases
smart constructor.
Instances
Create a value of ListDatabases
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:maxResults:ListDatabases'
, listDatabases_maxResults
- Specifies the maximum number of results to return.
ListDatabases
, listDatabases_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
ListDatabases
, listDatabases_catalogName
- The name of the data catalog that contains the databases to return.
data ListDatabasesResponse Source #
See: newListDatabasesResponse
smart constructor.
Instances
newListDatabasesResponse Source #
Create a value of ListDatabasesResponse
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:databaseList:ListDatabasesResponse'
, listDatabasesResponse_databaseList
- A list of databases from a data catalog.
ListDatabases
, listDatabasesResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the previous
page call.
$sel:httpStatus:ListDatabasesResponse'
, listDatabasesResponse_httpStatus
- The response's http status code.
ListEngineVersions
data ListEngineVersions Source #
See: newListEngineVersions
smart constructor.
Instances
newListEngineVersions :: ListEngineVersions Source #
Create a value of ListEngineVersions
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:maxResults:ListEngineVersions'
, listEngineVersions_maxResults
- The maximum number of engine versions to return in this request.
ListEngineVersions
, listEngineVersions_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
data ListEngineVersionsResponse Source #
See: newListEngineVersionsResponse
smart constructor.
Instances
newListEngineVersionsResponse Source #
Create a value of ListEngineVersionsResponse
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:engineVersions:ListEngineVersionsResponse'
, listEngineVersionsResponse_engineVersions
- A list of engine versions that are available to choose from.
ListEngineVersions
, listEngineVersionsResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:httpStatus:ListEngineVersionsResponse'
, listEngineVersionsResponse_httpStatus
- The response's http status code.
ListExecutors
data ListExecutors Source #
See: newListExecutors
smart constructor.
Instances
Create a value of ListExecutors
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:executorStateFilter:ListExecutors'
, listExecutors_executorStateFilter
- A filter for a specific executor state. A description of each state
follows.
CREATING
- The executor is being started, including acquiring
resources.
CREATED
- The executor has been started.
REGISTERED
- The executor has been registered.
TERMINATING
- The executor is in the process of shutting down.
TERMINATED
- The executor is no longer running.
FAILED
- Due to a failure, the executor is no longer running.
$sel:maxResults:ListExecutors'
, listExecutors_maxResults
- The maximum number of executors to return.
ListExecutors
, listExecutors_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
ListExecutors
, listExecutors_sessionId
- The session ID.
data ListExecutorsResponse Source #
See: newListExecutorsResponse
smart constructor.
Instances
newListExecutorsResponse Source #
Create a value of ListExecutorsResponse
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:executorsSummary:ListExecutorsResponse'
, listExecutorsResponse_executorsSummary
- Contains summary information about the executor.
ListExecutors
, listExecutorsResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:httpStatus:ListExecutorsResponse'
, listExecutorsResponse_httpStatus
- The response's http status code.
ListExecutors
, listExecutorsResponse_sessionId
- The session ID.
ListNamedQueries (Paginated)
data ListNamedQueries Source #
See: newListNamedQueries
smart constructor.
Instances
newListNamedQueries :: ListNamedQueries Source #
Create a value of ListNamedQueries
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:maxResults:ListNamedQueries'
, listNamedQueries_maxResults
- The maximum number of queries to return in this request.
ListNamedQueries
, listNamedQueries_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
ListNamedQueries
, listNamedQueries_workGroup
- The name of the workgroup from which the named queries are being
returned. If a workgroup is not specified, the saved queries for the
primary workgroup are returned.
data ListNamedQueriesResponse Source #
See: newListNamedQueriesResponse
smart constructor.
Instances
newListNamedQueriesResponse Source #
Create a value of ListNamedQueriesResponse
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:namedQueryIds:ListNamedQueriesResponse'
, listNamedQueriesResponse_namedQueryIds
- The list of unique query IDs.
ListNamedQueries
, listNamedQueriesResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:httpStatus:ListNamedQueriesResponse'
, listNamedQueriesResponse_httpStatus
- The response's http status code.
ListNotebookMetadata
data ListNotebookMetadata Source #
See: newListNotebookMetadata
smart constructor.
Instances
newListNotebookMetadata Source #
Create a value of ListNotebookMetadata
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:filters:ListNotebookMetadata'
, listNotebookMetadata_filters
- Search filter string.
$sel:maxResults:ListNotebookMetadata'
, listNotebookMetadata_maxResults
- Specifies the maximum number of results to return.
ListNotebookMetadata
, listNotebookMetadata_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated.
ListNotebookMetadata
, listNotebookMetadata_workGroup
- The name of the Spark enabled workgroup to retrieve notebook metadata
for.
data ListNotebookMetadataResponse Source #
See: newListNotebookMetadataResponse
smart constructor.
Instances
newListNotebookMetadataResponse Source #
Create a value of ListNotebookMetadataResponse
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:
ListNotebookMetadata
, listNotebookMetadataResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:notebookMetadataList:ListNotebookMetadataResponse'
, listNotebookMetadataResponse_notebookMetadataList
- The list of notebook metadata for the specified workgroup.
$sel:httpStatus:ListNotebookMetadataResponse'
, listNotebookMetadataResponse_httpStatus
- The response's http status code.
ListNotebookSessions
data ListNotebookSessions Source #
See: newListNotebookSessions
smart constructor.
Instances
newListNotebookSessions Source #
Create a value of ListNotebookSessions
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:maxResults:ListNotebookSessions'
, listNotebookSessions_maxResults
- The maximum number of notebook sessions to return.
ListNotebookSessions
, listNotebookSessions_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
ListNotebookSessions
, listNotebookSessions_notebookId
- The ID of the notebook to list sessions for.
data ListNotebookSessionsResponse Source #
See: newListNotebookSessionsResponse
smart constructor.
Instances
newListNotebookSessionsResponse Source #
Create a value of ListNotebookSessionsResponse
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:
ListNotebookSessions
, listNotebookSessionsResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:httpStatus:ListNotebookSessionsResponse'
, listNotebookSessionsResponse_httpStatus
- The response's http status code.
$sel:notebookSessionsList:ListNotebookSessionsResponse'
, listNotebookSessionsResponse_notebookSessionsList
- A list of the sessions belonging to the notebook.
ListPreparedStatements
data ListPreparedStatements Source #
See: newListPreparedStatements
smart constructor.
Instances
newListPreparedStatements Source #
Create a value of ListPreparedStatements
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:maxResults:ListPreparedStatements'
, listPreparedStatements_maxResults
- The maximum number of results to return in this request.
ListPreparedStatements
, listPreparedStatements_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
ListPreparedStatements
, listPreparedStatements_workGroup
- The workgroup to list the prepared statements for.
data ListPreparedStatementsResponse Source #
See: newListPreparedStatementsResponse
smart constructor.
Instances
newListPreparedStatementsResponse Source #
Create a value of ListPreparedStatementsResponse
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:
ListPreparedStatements
, listPreparedStatementsResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:preparedStatements:ListPreparedStatementsResponse'
, listPreparedStatementsResponse_preparedStatements
- The list of prepared statements for the workgroup.
$sel:httpStatus:ListPreparedStatementsResponse'
, listPreparedStatementsResponse_httpStatus
- The response's http status code.
ListQueryExecutions (Paginated)
data ListQueryExecutions Source #
See: newListQueryExecutions
smart constructor.
Instances
newListQueryExecutions :: ListQueryExecutions Source #
Create a value of ListQueryExecutions
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:maxResults:ListQueryExecutions'
, listQueryExecutions_maxResults
- The maximum number of query executions to return in this request.
ListQueryExecutions
, listQueryExecutions_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
ListQueryExecutions
, listQueryExecutions_workGroup
- The name of the workgroup from which queries are being returned. If a
workgroup is not specified, a list of available query execution IDs for
the queries in the primary workgroup is returned.
data ListQueryExecutionsResponse Source #
See: newListQueryExecutionsResponse
smart constructor.
Instances
newListQueryExecutionsResponse Source #
Create a value of ListQueryExecutionsResponse
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:
ListQueryExecutions
, listQueryExecutionsResponse_nextToken
- A token to be used by the next request if this request is truncated.
$sel:queryExecutionIds:ListQueryExecutionsResponse'
, listQueryExecutionsResponse_queryExecutionIds
- The unique IDs of each query execution as an array of strings.
$sel:httpStatus:ListQueryExecutionsResponse'
, listQueryExecutionsResponse_httpStatus
- The response's http status code.
ListSessions
data ListSessions Source #
See: newListSessions
smart constructor.
Instances
Create a value of ListSessions
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:maxResults:ListSessions'
, listSessions_maxResults
- The maximum number of sessions to return.
ListSessions
, listSessions_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:stateFilter:ListSessions'
, listSessions_stateFilter
- A filter for a specific session state. A description of each state
follows.
CREATING
- The session is being started, including acquiring
resources.
CREATED
- The session has been started.
IDLE
- The session is able to accept a calculation.
BUSY
- The session is processing another task and is unable to accept
a calculation.
TERMINATING
- The session is in the process of shutting down.
TERMINATED
- The session and its resources are no longer running.
DEGRADED
- The session has no healthy coordinators.
FAILED
- Due to a failure, the session and its resources are no longer
running.
ListSessions
, listSessions_workGroup
- The workgroup to which the session belongs.
data ListSessionsResponse Source #
See: newListSessionsResponse
smart constructor.
Instances
newListSessionsResponse Source #
Create a value of ListSessionsResponse
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:
ListSessions
, listSessionsResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:sessions:ListSessionsResponse'
, listSessionsResponse_sessions
- A list of sessions.
$sel:httpStatus:ListSessionsResponse'
, listSessionsResponse_httpStatus
- The response's http status code.
ListTableMetadata (Paginated)
data ListTableMetadata Source #
See: newListTableMetadata
smart constructor.
Instances
Create a value of ListTableMetadata
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:expression:ListTableMetadata'
, listTableMetadata_expression
- A regex filter that pattern-matches table names. If no expression is
supplied, metadata for all tables are listed.
$sel:maxResults:ListTableMetadata'
, listTableMetadata_maxResults
- Specifies the maximum number of results to return.
ListTableMetadata
, listTableMetadata_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the previous
page call.
ListTableMetadata
, listTableMetadata_catalogName
- The name of the data catalog for which table metadata should be
returned.
$sel:databaseName:ListTableMetadata'
, listTableMetadata_databaseName
- The name of the database for which table metadata should be returned.
data ListTableMetadataResponse Source #
See: newListTableMetadataResponse
smart constructor.
Instances
newListTableMetadataResponse Source #
Create a value of ListTableMetadataResponse
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:
ListTableMetadata
, listTableMetadataResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken from the response object of the previous
page call.
$sel:tableMetadataList:ListTableMetadataResponse'
, listTableMetadataResponse_tableMetadataList
- A list of table metadata.
$sel:httpStatus:ListTableMetadataResponse'
, listTableMetadataResponse_httpStatus
- The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:maxResults:ListTagsForResource'
, listTagsForResource_maxResults
- The maximum number of results to be returned per request that lists the
tags for the resource.
ListTagsForResource
, listTagsForResource_nextToken
- The token for the next set of results, or null if there are no
additional results for this request, where the request lists the tags
for the resource with the specified ARN.
$sel:resourceARN:ListTagsForResource'
, listTagsForResource_resourceARN
- Lists the tags for the resource with the specified ARN.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:
ListTagsForResource
, listTagsForResourceResponse_nextToken
- A token to be used by the next request if this request is truncated.
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The list of tags associated with the specified resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListWorkGroups
data ListWorkGroups Source #
See: newListWorkGroups
smart constructor.
Instances
newListWorkGroups :: ListWorkGroups Source #
Create a value of ListWorkGroups
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:maxResults:ListWorkGroups'
, listWorkGroups_maxResults
- The maximum number of workgroups to return in this request.
ListWorkGroups
, listWorkGroups_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
data ListWorkGroupsResponse Source #
See: newListWorkGroupsResponse
smart constructor.
Instances
newListWorkGroupsResponse Source #
Create a value of ListWorkGroupsResponse
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:
ListWorkGroups
, listWorkGroupsResponse_nextToken
- A token generated by the Athena service that specifies where to continue
pagination if a previous request was truncated. To obtain the next set
of pages, pass in the NextToken
from the response object of the
previous page call.
$sel:workGroups:ListWorkGroupsResponse'
, listWorkGroupsResponse_workGroups
- A list of WorkGroupSummary objects that include the names, descriptions,
creation times, and states for each workgroup.
$sel:httpStatus:ListWorkGroupsResponse'
, listWorkGroupsResponse_httpStatus
- The response's http status code.
StartCalculationExecution
data StartCalculationExecution Source #
See: newStartCalculationExecution
smart constructor.
StartCalculationExecution' (Maybe CalculationConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
newStartCalculationExecution Source #
Create a value of StartCalculationExecution
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:calculationConfiguration:StartCalculationExecution'
, startCalculationExecution_calculationConfiguration
- Contains configuration information for the calculation.
$sel:clientRequestToken:StartCalculationExecution'
, startCalculationExecution_clientRequestToken
- A unique case-sensitive string used to ensure the request to create the
calculation is idempotent (executes only once). If another
StartCalculationExecutionRequest
is received, the same response is
returned and another calculation is not created. If a parameter has
changed, an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
StartCalculationExecution
, startCalculationExecution_codeBlock
- A string that contains the code of the calculation.
StartCalculationExecution
, startCalculationExecution_description
- A description of the calculation.
StartCalculationExecution
, startCalculationExecution_sessionId
- The session ID.
data StartCalculationExecutionResponse Source #
See: newStartCalculationExecutionResponse
smart constructor.
Instances
newStartCalculationExecutionResponse Source #
Create a value of StartCalculationExecutionResponse
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:
StartCalculationExecutionResponse
, startCalculationExecutionResponse_calculationExecutionId
- The calculation execution UUID.
StartCalculationExecutionResponse
, startCalculationExecutionResponse_state
- CREATING
- The calculation is in the process of being created.
CREATED
- The calculation has been created and is ready to run.
QUEUED
- The calculation has been queued for processing.
RUNNING
- The calculation is running.
CANCELING
- A request to cancel the calculation has been received and
the system is working to stop it.
CANCELED
- The calculation is no longer running as the result of a
cancel request.
COMPLETED
- The calculation has completed without error.
FAILED
- The calculation failed and is no longer running.
$sel:httpStatus:StartCalculationExecutionResponse'
, startCalculationExecutionResponse_httpStatus
- The response's http status code.
StartQueryExecution
data StartQueryExecution Source #
See: newStartQueryExecution
smart constructor.
StartQueryExecution' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe QueryExecutionContext) (Maybe ResultConfiguration) (Maybe ResultReuseConfiguration) (Maybe Text) Text |
Instances
newStartQueryExecution Source #
Create a value of StartQueryExecution
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:clientRequestToken:StartQueryExecution'
, startQueryExecution_clientRequestToken
- A unique case-sensitive string used to ensure the request to create the
query is idempotent (executes only once). If another
StartQueryExecution
request is received, the same response is returned
and another query is not created. If a parameter has changed, for
example, the QueryString
, an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
StartQueryExecution
, startQueryExecution_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.
StartQueryExecution
, startQueryExecution_queryExecutionContext
- The database within which the query executes.
StartQueryExecution
, startQueryExecution_resultConfiguration
- Specifies information about where and how to save the results of the
query execution. If the query runs in a workgroup, then workgroup's
settings may override query settings. This affects the query results
location. The workgroup settings override is specified in
EnforceWorkGroupConfiguration (true/false) in the
WorkGroupConfiguration. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
StartQueryExecution
, startQueryExecution_resultReuseConfiguration
- Specifies the query result reuse behavior for the query.
StartQueryExecution
, startQueryExecution_workGroup
- The name of the workgroup in which the query is being started.
StartQueryExecution
, startQueryExecution_queryString
- The SQL query statements to be executed.
data StartQueryExecutionResponse Source #
See: newStartQueryExecutionResponse
smart constructor.
Instances
newStartQueryExecutionResponse Source #
Create a value of StartQueryExecutionResponse
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:
StartQueryExecutionResponse
, startQueryExecutionResponse_queryExecutionId
- The unique ID of the query that ran as a result of this request.
$sel:httpStatus:StartQueryExecutionResponse'
, startQueryExecutionResponse_httpStatus
- The response's http status code.
StartSession
data StartSession Source #
See: newStartSession
smart constructor.
Instances
Create a value of StartSession
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:clientRequestToken:StartSession'
, startSession_clientRequestToken
- A unique case-sensitive string used to ensure the request to create the
session is idempotent (executes only once). If another
StartSessionRequest
is received, the same response is returned and
another session is not created. If a parameter has changed, an error is
returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
StartSession
, startSession_description
- The session description.
StartSession
, startSession_notebookVersion
- The notebook version. This value is required only when requesting that a
notebook server be started for the session. The only valid notebook
version is Jupyter1.0
.
$sel:sessionIdleTimeoutInMinutes:StartSession'
, startSession_sessionIdleTimeoutInMinutes
- The idle timeout in minutes for the session.
StartSession
, startSession_workGroup
- The workgroup to which the session belongs.
$sel:engineConfiguration:StartSession'
, startSession_engineConfiguration
- Contains engine data processing unit (DPU) configuration settings and
parameter mappings.
data StartSessionResponse Source #
See: newStartSessionResponse
smart constructor.
Instances
newStartSessionResponse Source #
Create a value of StartSessionResponse
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:
StartSessionResponse
, startSessionResponse_sessionId
- The session ID.
StartSessionResponse
, startSessionResponse_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:httpStatus:StartSessionResponse'
, startSessionResponse_httpStatus
- The response's http status code.
StopCalculationExecution
data StopCalculationExecution Source #
See: newStopCalculationExecution
smart constructor.
Instances
newStopCalculationExecution Source #
Create a value of StopCalculationExecution
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:
StopCalculationExecution
, stopCalculationExecution_calculationExecutionId
- The calculation execution UUID.
data StopCalculationExecutionResponse Source #
See: newStopCalculationExecutionResponse
smart constructor.
Instances
Generic StopCalculationExecutionResponse Source # | |
Read StopCalculationExecutionResponse Source # | |
Show StopCalculationExecutionResponse Source # | |
Defined in Amazonka.Athena.StopCalculationExecution | |
NFData StopCalculationExecutionResponse Source # | |
Defined in Amazonka.Athena.StopCalculationExecution rnf :: StopCalculationExecutionResponse -> () # | |
Eq StopCalculationExecutionResponse Source # | |
type Rep StopCalculationExecutionResponse Source # | |
Defined in Amazonka.Athena.StopCalculationExecution type Rep StopCalculationExecutionResponse = D1 ('MetaData "StopCalculationExecutionResponse" "Amazonka.Athena.StopCalculationExecution" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "StopCalculationExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CalculationExecutionState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStopCalculationExecutionResponse Source #
Create a value of StopCalculationExecutionResponse
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:
StopCalculationExecutionResponse
, stopCalculationExecutionResponse_state
- CREATING
- The calculation is in the process of being created.
CREATED
- The calculation has been created and is ready to run.
QUEUED
- The calculation has been queued for processing.
RUNNING
- The calculation is running.
CANCELING
- A request to cancel the calculation has been received and
the system is working to stop it.
CANCELED
- The calculation is no longer running as the result of a
cancel request.
COMPLETED
- The calculation has completed without error.
FAILED
- The calculation failed and is no longer running.
$sel:httpStatus:StopCalculationExecutionResponse'
, stopCalculationExecutionResponse_httpStatus
- The response's http status code.
StopQueryExecution
data StopQueryExecution Source #
See: newStopQueryExecution
smart constructor.
Instances
newStopQueryExecution Source #
Create a value of StopQueryExecution
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:
StopQueryExecution
, stopQueryExecution_queryExecutionId
- The unique ID of the query execution to stop.
data StopQueryExecutionResponse Source #
See: newStopQueryExecutionResponse
smart constructor.
Instances
newStopQueryExecutionResponse Source #
Create a value of StopQueryExecutionResponse
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:httpStatus:StopQueryExecutionResponse'
, stopQueryExecutionResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceARN:TagResource'
, tagResource_resourceARN
- Specifies the ARN of the Athena resource (workgroup or data catalog) to
which tags are to be added.
$sel:tags:TagResource'
, tagResource_tags
- A collection of one or more tags, separated by commas, to be added to an
Athena workgroup or data catalog resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
TerminateSession
data TerminateSession Source #
See: newTerminateSession
smart constructor.
Instances
Create a value of TerminateSession
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:
TerminateSession
, terminateSession_sessionId
- The session ID.
data TerminateSessionResponse Source #
See: newTerminateSessionResponse
smart constructor.
Instances
newTerminateSessionResponse Source #
Create a value of TerminateSessionResponse
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:
TerminateSessionResponse
, terminateSessionResponse_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:httpStatus:TerminateSessionResponse'
, terminateSessionResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceARN:UntagResource'
, untagResource_resourceARN
- Specifies the ARN of the resource from which tags are to be removed.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A comma-separated list of one or more tag keys whose tags are to be
removed from the specified resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateDataCatalog
data UpdateDataCatalog Source #
See: newUpdateDataCatalog
smart constructor.
Instances
Create a value of UpdateDataCatalog
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:
UpdateDataCatalog
, updateDataCatalog_description
- New or modified text that describes the data catalog.
UpdateDataCatalog
, updateDataCatalog_parameters
- Specifies the Lambda function or functions to use for updating the data
catalog. This is a mapping whose values depend on the catalog type.
For the
HIVE
data catalog type, use the following syntax. Themetadata-function
parameter is required.The sdk-version
parameter is optional and defaults to the currently supported version.metadata-function=
lambda_arn
, sdk-version=
version_number
For the
LAMBDA
data catalog type, use one of the following sets of required parameters, but not both.If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=
lambda_arn
, record-function=
lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=
lambda_arn
UpdateDataCatalog
, updateDataCatalog_name
- The name of the data catalog to update. The catalog name must be unique
for the Amazon Web Services account and can use a maximum of 127
alphanumeric, underscore, at sign, or hyphen characters. The remainder
of the length constraint of 256 is reserved for use by Athena.
UpdateDataCatalog
, updateDataCatalog_type
- Specifies the type of data catalog to update. Specify LAMBDA
for a
federated catalog, HIVE
for an external hive metastore, or GLUE
for
an Glue Data Catalog.
data UpdateDataCatalogResponse Source #
See: newUpdateDataCatalogResponse
smart constructor.
Instances
newUpdateDataCatalogResponse Source #
Create a value of UpdateDataCatalogResponse
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:httpStatus:UpdateDataCatalogResponse'
, updateDataCatalogResponse_httpStatus
- The response's http status code.
UpdateNamedQuery
data UpdateNamedQuery Source #
See: newUpdateNamedQuery
smart constructor.
Instances
Create a value of UpdateNamedQuery
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:
UpdateNamedQuery
, updateNamedQuery_description
- The query description.
UpdateNamedQuery
, updateNamedQuery_namedQueryId
- The unique identifier (UUID) of the query.
UpdateNamedQuery
, updateNamedQuery_name
- The name of the query.
UpdateNamedQuery
, updateNamedQuery_queryString
- The contents of the query with all query statements.
data UpdateNamedQueryResponse Source #
See: newUpdateNamedQueryResponse
smart constructor.
Instances
newUpdateNamedQueryResponse Source #
Create a value of UpdateNamedQueryResponse
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:httpStatus:UpdateNamedQueryResponse'
, updateNamedQueryResponse_httpStatus
- The response's http status code.
UpdateNotebook
data UpdateNotebook Source #
See: newUpdateNotebook
smart constructor.
Instances
:: Text | |
-> Text | |
-> NotebookType | |
-> UpdateNotebook |
Create a value of UpdateNotebook
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:clientRequestToken:UpdateNotebook'
, updateNotebook_clientRequestToken
- A unique case-sensitive string used to ensure the request to create the
notebook is idempotent (executes only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
UpdateNotebook
, updateNotebook_sessionId
- The ID of the session in which the notebook will be updated.
UpdateNotebook
, updateNotebook_notebookId
- The ID of the notebook to update.
$sel:payload:UpdateNotebook'
, updateNotebook_payload
- The updated content for the notebook.
UpdateNotebook
, updateNotebook_type
- The notebook content type. Currently, the only valid type is IPYNB
.
data UpdateNotebookResponse Source #
See: newUpdateNotebookResponse
smart constructor.
Instances
Generic UpdateNotebookResponse Source # | |
Defined in Amazonka.Athena.UpdateNotebook type Rep UpdateNotebookResponse :: Type -> Type # | |
Read UpdateNotebookResponse Source # | |
Show UpdateNotebookResponse Source # | |
Defined in Amazonka.Athena.UpdateNotebook showsPrec :: Int -> UpdateNotebookResponse -> ShowS # show :: UpdateNotebookResponse -> String # showList :: [UpdateNotebookResponse] -> ShowS # | |
NFData UpdateNotebookResponse Source # | |
Defined in Amazonka.Athena.UpdateNotebook rnf :: UpdateNotebookResponse -> () # | |
Eq UpdateNotebookResponse Source # | |
Defined in Amazonka.Athena.UpdateNotebook | |
type Rep UpdateNotebookResponse Source # | |
Defined in Amazonka.Athena.UpdateNotebook type Rep UpdateNotebookResponse = D1 ('MetaData "UpdateNotebookResponse" "Amazonka.Athena.UpdateNotebook" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "UpdateNotebookResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateNotebookResponse Source #
Create a value of UpdateNotebookResponse
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:httpStatus:UpdateNotebookResponse'
, updateNotebookResponse_httpStatus
- The response's http status code.
UpdateNotebookMetadata
data UpdateNotebookMetadata Source #
See: newUpdateNotebookMetadata
smart constructor.
Instances
newUpdateNotebookMetadata Source #
Create a value of UpdateNotebookMetadata
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:clientRequestToken:UpdateNotebookMetadata'
, updateNotebookMetadata_clientRequestToken
- A unique case-sensitive string used to ensure the request to create the
notebook is idempotent (executes only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
UpdateNotebookMetadata
, updateNotebookMetadata_notebookId
- The ID of the notebook to update the metadata for.
UpdateNotebookMetadata
, updateNotebookMetadata_name
- The name to update the notebook to.
data UpdateNotebookMetadataResponse Source #
See: newUpdateNotebookMetadataResponse
smart constructor.
Instances
Generic UpdateNotebookMetadataResponse Source # | |
Read UpdateNotebookMetadataResponse Source # | |
Show UpdateNotebookMetadataResponse Source # | |
Defined in Amazonka.Athena.UpdateNotebookMetadata | |
NFData UpdateNotebookMetadataResponse Source # | |
Defined in Amazonka.Athena.UpdateNotebookMetadata rnf :: UpdateNotebookMetadataResponse -> () # | |
Eq UpdateNotebookMetadataResponse Source # | |
type Rep UpdateNotebookMetadataResponse Source # | |
Defined in Amazonka.Athena.UpdateNotebookMetadata type Rep UpdateNotebookMetadataResponse = D1 ('MetaData "UpdateNotebookMetadataResponse" "Amazonka.Athena.UpdateNotebookMetadata" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "UpdateNotebookMetadataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateNotebookMetadataResponse Source #
Create a value of UpdateNotebookMetadataResponse
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:httpStatus:UpdateNotebookMetadataResponse'
, updateNotebookMetadataResponse_httpStatus
- The response's http status code.
UpdatePreparedStatement
data UpdatePreparedStatement Source #
See: newUpdatePreparedStatement
smart constructor.
Instances
newUpdatePreparedStatement Source #
:: Text | |
-> Text | |
-> Text | |
-> UpdatePreparedStatement |
Create a value of UpdatePreparedStatement
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:
UpdatePreparedStatement
, updatePreparedStatement_description
- The description of the prepared statement.
UpdatePreparedStatement
, updatePreparedStatement_statementName
- The name of the prepared statement.
UpdatePreparedStatement
, updatePreparedStatement_workGroup
- The workgroup for the prepared statement.
UpdatePreparedStatement
, updatePreparedStatement_queryStatement
- The query string for the prepared statement.
data UpdatePreparedStatementResponse Source #
See: newUpdatePreparedStatementResponse
smart constructor.
Instances
Generic UpdatePreparedStatementResponse Source # | |
Read UpdatePreparedStatementResponse Source # | |
Show UpdatePreparedStatementResponse Source # | |
Defined in Amazonka.Athena.UpdatePreparedStatement | |
NFData UpdatePreparedStatementResponse Source # | |
Defined in Amazonka.Athena.UpdatePreparedStatement rnf :: UpdatePreparedStatementResponse -> () # | |
Eq UpdatePreparedStatementResponse Source # | |
type Rep UpdatePreparedStatementResponse Source # | |
Defined in Amazonka.Athena.UpdatePreparedStatement type Rep UpdatePreparedStatementResponse = D1 ('MetaData "UpdatePreparedStatementResponse" "Amazonka.Athena.UpdatePreparedStatement" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "UpdatePreparedStatementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdatePreparedStatementResponse Source #
Create a value of UpdatePreparedStatementResponse
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:httpStatus:UpdatePreparedStatementResponse'
, updatePreparedStatementResponse_httpStatus
- The response's http status code.
UpdateWorkGroup
data UpdateWorkGroup Source #
See: newUpdateWorkGroup
smart constructor.
Instances
Create a value of UpdateWorkGroup
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:configurationUpdates:UpdateWorkGroup'
, updateWorkGroup_configurationUpdates
- Contains configuration updates for an Athena SQL workgroup.
UpdateWorkGroup
, updateWorkGroup_description
- The workgroup description.
UpdateWorkGroup
, updateWorkGroup_state
- The workgroup state that will be updated for the given workgroup.
UpdateWorkGroup
, updateWorkGroup_workGroup
- The specified workgroup that will be updated.
data UpdateWorkGroupResponse Source #
See: newUpdateWorkGroupResponse
smart constructor.
Instances
newUpdateWorkGroupResponse Source #
Create a value of UpdateWorkGroupResponse
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:httpStatus:UpdateWorkGroupResponse'
, updateWorkGroupResponse_httpStatus
- The response's http status code.
Types
CalculationExecutionState
newtype CalculationExecutionState Source #
Instances
ColumnNullable
newtype ColumnNullable Source #
pattern ColumnNullable_NOT_NULL :: ColumnNullable | |
pattern ColumnNullable_NULLABLE :: ColumnNullable | |
pattern ColumnNullable_UNKNOWN :: ColumnNullable |
Instances
DataCatalogType
newtype DataCatalogType Source #
pattern DataCatalogType_GLUE :: DataCatalogType | |
pattern DataCatalogType_HIVE :: DataCatalogType | |
pattern DataCatalogType_LAMBDA :: DataCatalogType |
Instances
EncryptionOption
newtype EncryptionOption Source #
pattern EncryptionOption_CSE_KMS :: EncryptionOption | |
pattern EncryptionOption_SSE_KMS :: EncryptionOption | |
pattern EncryptionOption_SSE_S3 :: EncryptionOption |
Instances
ExecutorState
newtype ExecutorState Source #
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 #
pattern ExecutorType_COORDINATOR :: ExecutorType | |
pattern ExecutorType_GATEWAY :: ExecutorType | |
pattern ExecutorType_WORKER :: ExecutorType |
Instances
NotebookType
newtype NotebookType Source #
pattern NotebookType_IPYNB :: NotebookType |
Instances
QueryExecutionState
newtype QueryExecutionState Source #
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 #
pattern S3AclOption_BUCKET_OWNER_FULL_CONTROL :: S3AclOption |
Instances
SessionState
newtype SessionState Source #
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 #
pattern StatementType_DDL :: StatementType | |
pattern StatementType_DML :: StatementType | |
pattern StatementType_UTILITY :: StatementType |
Instances
WorkGroupState
newtype WorkGroupState Source #
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.
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.
ApplicationDPUSizes
data ApplicationDPUSizes Source #
Contains the application runtime IDs and their supported DPU sizes.
See: newApplicationDPUSizes
smart constructor.
ApplicationDPUSizes' (Maybe Text) (Maybe [Int]) |
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.
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.
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.
CalculationConfiguration
data CalculationConfiguration Source #
Contains configuration information for the calculation.
See: newCalculationConfiguration
smart constructor.
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.
CalculationResult
data CalculationResult Source #
Contains information about an application-specific calculation result.
See: newCalculationResult
smart constructor.
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.
CalculationStatistics
data CalculationStatistics Source #
Contains statistics for a notebook calculation.
See: newCalculationStatistics
smart constructor.
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.
CalculationStatus
data CalculationStatus Source #
Contains information about the status of a notebook calculation.
See: newCalculationStatus
smart constructor.
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.
CalculationSummary
data CalculationSummary Source #
Summary information for a notebook calculation.
See: newCalculationSummary
smart constructor.
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.
Column
Contains metadata for a column in a table.
See: newColumn
smart constructor.
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.
ColumnInfo' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ColumnNullable) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) Text Text |
Instances
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.
CustomerContentEncryptionConfiguration
data CustomerContentEncryptionConfiguration Source #
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
See: newCustomerContentEncryptionConfiguration
smart constructor.
Instances
FromJSON CustomerContentEncryptionConfiguration Source # | |
ToJSON CustomerContentEncryptionConfiguration Source # | |
Generic CustomerContentEncryptionConfiguration Source # | |
Read CustomerContentEncryptionConfiguration Source # | |
Show CustomerContentEncryptionConfiguration Source # | |
NFData CustomerContentEncryptionConfiguration Source # | |
Eq CustomerContentEncryptionConfiguration Source # | |
Hashable CustomerContentEncryptionConfiguration Source # | |
type Rep CustomerContentEncryptionConfiguration Source # | |
Defined in Amazonka.Athena.Types.CustomerContentEncryptionConfiguration type Rep CustomerContentEncryptionConfiguration = D1 ('MetaData "CustomerContentEncryptionConfiguration" "Amazonka.Athena.Types.CustomerContentEncryptionConfiguration" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "CustomerContentEncryptionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newCustomerContentEncryptionConfiguration Source #
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.
DataCatalog
data DataCatalog Source #
Contains information about a data catalog in an Amazon Web Services account.
See: newDataCatalog
smart constructor.
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
HIVE
data catalog type, use the following syntax. Themetadata-function
parameter is required.The sdk-version
parameter is optional and defaults to the currently supported version.metadata-function=
lambda_arn
, sdk-version=
version_number
For the
LAMBDA
data catalog type, use one of the following sets of required parameters, but not both.If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=
lambda_arn
, record-function=
lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=
lambda_arn
The
GLUE
type takes a catalog ID parameter and is required. Thecatalog_id
catalog-id=
catalog_id
- The
GLUE
data catalog type also applies to the defaultAwsDataCatalog
that already exists in your account, of which you can have only one and cannot modify. - Queries that specify a Glue Data Catalog other than the default
AwsDataCatalog
must be run on Athena engine version 2.
- 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.
DataCatalogSummary
data DataCatalogSummary Source #
The summary information for the data catalog, which includes its name and type.
See: newDataCatalogSummary
smart constructor.
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.
Database
Contains metadata information for a database in a data catalog.
See: newDatabase
smart constructor.
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.
Datum
A piece of data (a field in the table).
See: newDatum
smart constructor.
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.
Instances
newEncryptionConfiguration Source #
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.
EngineConfiguration
data EngineConfiguration Source #
Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.
See: newEngineConfiguration
smart constructor.
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.
EngineVersion
data EngineVersion Source #
The Athena engine version for running queries, or the PySpark engine version for running sessions.
See: newEngineVersion
smart constructor.
EngineVersion' (Maybe Text) (Maybe Text) |
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.
ExecutorsSummary
data ExecutorsSummary Source #
Contains summary information about an executor.
See: newExecutorsSummary
smart constructor.
ExecutorsSummary' (Maybe Integer) (Maybe ExecutorState) (Maybe ExecutorType) (Maybe Integer) (Maybe Integer) Text |
Instances
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.
FilterDefinition
data FilterDefinition Source #
A string for searching notebook names.
See: newFilterDefinition
smart constructor.
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.
NamedQuery
data NamedQuery Source #
A query, where QueryString
contains the SQL statements that make up
the query.
See: newNamedQuery
smart constructor.
Instances
:: 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.
NotebookMetadata
data NotebookMetadata Source #
Contains metadata for notebook, including the notebook name, ID, workgroup, and time created.
See: newNotebookMetadata
smart constructor.
NotebookMetadata' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe NotebookType) (Maybe Text) |
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.
NotebookSessionSummary
data NotebookSessionSummary Source #
Contains the notebook session ID and notebook session creation time.
See: newNotebookSessionSummary
smart constructor.
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.
PreparedStatement
data PreparedStatement Source #
A prepared SQL statement for use with Athena.
See: newPreparedStatement
smart constructor.
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.
PreparedStatementSummary
data PreparedStatementSummary Source #
The name and last modified time of the prepared statement.
See: newPreparedStatementSummary
smart constructor.
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.
QueryExecution
data QueryExecution Source #
Information about a single instance of a query execution.
See: newQueryExecution
smart constructor.
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.
QueryExecutionContext
data QueryExecutionContext Source #
The database and data catalog context in which the query execution occurs.
See: newQueryExecutionContext
smart constructor.
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.
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.
QueryExecutionStatistics' (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe ResultReuseInformation) (Maybe Integer) (Maybe Integer) |
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.
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.
QueryExecutionStatus' (Maybe AthenaError) (Maybe POSIX) (Maybe QueryExecutionState) (Maybe Text) (Maybe POSIX) |
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.
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.
QueryRuntimeStatistics' (Maybe QueryStage) (Maybe QueryRuntimeStatisticsRows) (Maybe QueryRuntimeStatisticsTimeline) |
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.
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.
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.
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.
QueryRuntimeStatisticsTimeline' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) |
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.
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.
QueryStage' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe QueryStagePlanNode) (Maybe Integer) (Maybe Text) (Maybe [QueryStage]) |
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.
QueryStagePlanNode
data QueryStagePlanNode Source #
Stage plan information such as name, identifier, sub plans, and remote sources.
See: newQueryStagePlanNode
smart constructor.
QueryStagePlanNode' (Maybe [QueryStagePlanNode]) (Maybe Text) (Maybe Text) (Maybe [Text]) |
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.
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.
ResultConfiguration' (Maybe AclConfiguration) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text) |
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.
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.
ResultConfigurationUpdates' (Maybe AclConfiguration) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) |
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.
ResultReuseByAgeConfiguration
data ResultReuseByAgeConfiguration Source #
Specifies whether previous query results are reused, and if so, their maximum age.
See: newResultReuseByAgeConfiguration
smart constructor.
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.
ResultReuseConfiguration
data ResultReuseConfiguration Source #
Specifies the query result reuse behavior for the query.
See: newResultReuseConfiguration
smart constructor.
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.
ResultReuseInformation
data ResultReuseInformation Source #
Contains information about whether the result of a previous query was reused.
See: newResultReuseInformation
smart constructor.
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.
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.
ResultSet' (Maybe ResultSetMetadata) (Maybe [Row]) |
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.
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.
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.
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.
SessionConfiguration
data SessionConfiguration Source #
Contains session configuration information.
See: newSessionConfiguration
smart constructor.
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.
SessionStatistics
data SessionStatistics Source #
Contains statistics for a notebook session.
See: newSessionStatistics
smart constructor.
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.
SessionStatus
data SessionStatus Source #
Contains information about the status of a notebook session.
See: newSessionStatus
smart constructor.
SessionStatus' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe SessionState) (Maybe Text) |
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).
SessionSummary
data SessionSummary Source #
Contains summary information about a notebook session.
See: newSessionSummary
smart constructor.
SessionSummary' (Maybe Text) (Maybe EngineVersion) (Maybe Text) (Maybe Text) (Maybe SessionStatus) |
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.
TableMetadata
data TableMetadata Source #
Contains metadata for a table.
See: newTableMetadata
smart constructor.
TableMetadata' (Maybe [Column]) (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap Text Text)) (Maybe [Column]) (Maybe Text) Text |
Instances
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.
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.
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.
UnprocessedNamedQueryId
data UnprocessedNamedQueryId Source #
Information about a named query ID that could not be processed.
See: newUnprocessedNamedQueryId
smart constructor.
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.
UnprocessedPreparedStatementName
data UnprocessedPreparedStatementName Source #
The name of a prepared statement that could not be returned.
See: newUnprocessedPreparedStatementName
smart constructor.
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.
UnprocessedQueryExecutionId
data UnprocessedQueryExecutionId Source #
Describes a query execution that failed to process.
See: newUnprocessedQueryExecutionId
smart constructor.
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.
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.
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.
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.
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.
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.
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.
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.
WorkGroupSummary' (Maybe POSIX) (Maybe Text) (Maybe EngineVersion) (Maybe Text) (Maybe WorkGroupState) |
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.