| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Athena
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- ListDatabases (Paginated)
- CreatePreparedStatement
- DeleteWorkGroup
- UpdateWorkGroup
- GetNamedQuery
- ListTagsForResource (Paginated)
- DeleteDataCatalog
- UpdateDataCatalog
- ListDataCatalogs (Paginated)
- CreateNamedQuery
- GetTableMetadata
- ListNamedQueries (Paginated)
- DeleteNamedQuery
- StartQueryExecution
- BatchGetNamedQuery
- GetQueryExecution
- ListPreparedStatements
- CreateDataCatalog
- ListWorkGroups
- CreateWorkGroup
- BatchGetQueryExecution
- ListEngineVersions
- GetDataCatalog
- StopQueryExecution
- TagResource
- GetWorkGroup
- GetDatabase
- UntagResource
- GetPreparedStatement
- GetQueryResults (Paginated)
- ListTableMetadata (Paginated)
- ListQueryExecutions (Paginated)
- DeletePreparedStatement
- UpdatePreparedStatement
- Types
- ColumnNullable
- DataCatalogType
- EncryptionOption
- QueryExecutionState
- StatementType
- WorkGroupState
- Column
- ColumnInfo
- DataCatalog
- DataCatalogSummary
- Database
- Datum
- EncryptionConfiguration
- EngineVersion
- NamedQuery
- PreparedStatement
- PreparedStatementSummary
- QueryExecution
- QueryExecutionContext
- QueryExecutionStatistics
- QueryExecutionStatus
- ResultConfiguration
- ResultConfigurationUpdates
- ResultSet
- ResultSetMetadata
- Row
- TableMetadata
- Tag
- UnprocessedNamedQueryId
- UnprocessedQueryExecutionId
- WorkGroup
- WorkGroupConfiguration
- WorkGroupConfigurationUpdates
- WorkGroupSummary
Description
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
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _MetadataException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListDatabases = ListDatabases' (Maybe Text) (Maybe Natural) Text
- newListDatabases :: Text -> ListDatabases
- data ListDatabasesResponse = ListDatabasesResponse' (Maybe [Database]) (Maybe Text) Int
- newListDatabasesResponse :: Int -> ListDatabasesResponse
- data CreatePreparedStatement = CreatePreparedStatement' (Maybe Text) Text Text Text
- newCreatePreparedStatement :: Text -> Text -> Text -> CreatePreparedStatement
- data CreatePreparedStatementResponse = CreatePreparedStatementResponse' Int
- newCreatePreparedStatementResponse :: Int -> CreatePreparedStatementResponse
- data DeleteWorkGroup = DeleteWorkGroup' (Maybe Bool) Text
- newDeleteWorkGroup :: Text -> DeleteWorkGroup
- data DeleteWorkGroupResponse = DeleteWorkGroupResponse' Int
- newDeleteWorkGroupResponse :: Int -> DeleteWorkGroupResponse
- data UpdateWorkGroup = UpdateWorkGroup' (Maybe WorkGroupState) (Maybe WorkGroupConfigurationUpdates) (Maybe Text) Text
- newUpdateWorkGroup :: Text -> UpdateWorkGroup
- data UpdateWorkGroupResponse = UpdateWorkGroupResponse' Int
- newUpdateWorkGroupResponse :: Int -> UpdateWorkGroupResponse
- data GetNamedQuery = GetNamedQuery' Text
- newGetNamedQuery :: Text -> GetNamedQuery
- data GetNamedQueryResponse = GetNamedQueryResponse' (Maybe NamedQuery) Int
- newGetNamedQueryResponse :: Int -> GetNamedQueryResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Text) (Maybe Natural) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DeleteDataCatalog = DeleteDataCatalog' Text
- newDeleteDataCatalog :: Text -> DeleteDataCatalog
- data DeleteDataCatalogResponse = DeleteDataCatalogResponse' Int
- newDeleteDataCatalogResponse :: Int -> DeleteDataCatalogResponse
- data UpdateDataCatalog = UpdateDataCatalog' (Maybe (HashMap Text Text)) (Maybe Text) Text DataCatalogType
- newUpdateDataCatalog :: Text -> DataCatalogType -> UpdateDataCatalog
- data UpdateDataCatalogResponse = UpdateDataCatalogResponse' Int
- newUpdateDataCatalogResponse :: Int -> UpdateDataCatalogResponse
- data ListDataCatalogs = ListDataCatalogs' (Maybe Text) (Maybe Natural)
- newListDataCatalogs :: ListDataCatalogs
- data ListDataCatalogsResponse = ListDataCatalogsResponse' (Maybe [DataCatalogSummary]) (Maybe Text) Int
- newListDataCatalogsResponse :: Int -> ListDataCatalogsResponse
- 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 GetTableMetadata = GetTableMetadata' Text Text Text
- newGetTableMetadata :: Text -> Text -> Text -> GetTableMetadata
- data GetTableMetadataResponse = GetTableMetadataResponse' (Maybe TableMetadata) Int
- newGetTableMetadataResponse :: Int -> GetTableMetadataResponse
- data ListNamedQueries = ListNamedQueries' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListNamedQueries :: ListNamedQueries
- data ListNamedQueriesResponse = ListNamedQueriesResponse' (Maybe Text) (Maybe (NonEmpty Text)) Int
- newListNamedQueriesResponse :: Int -> ListNamedQueriesResponse
- data DeleteNamedQuery = DeleteNamedQuery' Text
- newDeleteNamedQuery :: Text -> DeleteNamedQuery
- data DeleteNamedQueryResponse = DeleteNamedQueryResponse' Int
- newDeleteNamedQueryResponse :: Int -> DeleteNamedQueryResponse
- data StartQueryExecution = StartQueryExecution' (Maybe QueryExecutionContext) (Maybe ResultConfiguration) (Maybe Text) (Maybe Text) Text
- newStartQueryExecution :: Text -> StartQueryExecution
- data StartQueryExecutionResponse = StartQueryExecutionResponse' (Maybe Text) Int
- newStartQueryExecutionResponse :: Int -> StartQueryExecutionResponse
- data BatchGetNamedQuery = BatchGetNamedQuery' (NonEmpty Text)
- newBatchGetNamedQuery :: NonEmpty Text -> BatchGetNamedQuery
- data BatchGetNamedQueryResponse = BatchGetNamedQueryResponse' (Maybe [NamedQuery]) (Maybe [UnprocessedNamedQueryId]) Int
- newBatchGetNamedQueryResponse :: Int -> BatchGetNamedQueryResponse
- data GetQueryExecution = GetQueryExecution' Text
- newGetQueryExecution :: Text -> GetQueryExecution
- data GetQueryExecutionResponse = GetQueryExecutionResponse' (Maybe QueryExecution) Int
- newGetQueryExecutionResponse :: Int -> GetQueryExecutionResponse
- data ListPreparedStatements = ListPreparedStatements' (Maybe Text) (Maybe Natural) Text
- newListPreparedStatements :: Text -> ListPreparedStatements
- data ListPreparedStatementsResponse = ListPreparedStatementsResponse' (Maybe [PreparedStatementSummary]) (Maybe Text) Int
- newListPreparedStatementsResponse :: Int -> ListPreparedStatementsResponse
- data CreateDataCatalog = CreateDataCatalog' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Tag]) Text DataCatalogType
- newCreateDataCatalog :: Text -> DataCatalogType -> CreateDataCatalog
- data CreateDataCatalogResponse = CreateDataCatalogResponse' Int
- newCreateDataCatalogResponse :: Int -> CreateDataCatalogResponse
- data ListWorkGroups = ListWorkGroups' (Maybe Text) (Maybe Natural)
- newListWorkGroups :: ListWorkGroups
- data ListWorkGroupsResponse = ListWorkGroupsResponse' (Maybe Text) (Maybe [WorkGroupSummary]) Int
- newListWorkGroupsResponse :: Int -> ListWorkGroupsResponse
- data CreateWorkGroup = CreateWorkGroup' (Maybe WorkGroupConfiguration) (Maybe Text) (Maybe [Tag]) Text
- newCreateWorkGroup :: Text -> CreateWorkGroup
- data CreateWorkGroupResponse = CreateWorkGroupResponse' Int
- newCreateWorkGroupResponse :: Int -> CreateWorkGroupResponse
- data BatchGetQueryExecution = BatchGetQueryExecution' (NonEmpty Text)
- newBatchGetQueryExecution :: NonEmpty Text -> BatchGetQueryExecution
- data BatchGetQueryExecutionResponse = BatchGetQueryExecutionResponse' (Maybe [UnprocessedQueryExecutionId]) (Maybe [QueryExecution]) Int
- newBatchGetQueryExecutionResponse :: Int -> BatchGetQueryExecutionResponse
- data ListEngineVersions = ListEngineVersions' (Maybe Text) (Maybe Natural)
- newListEngineVersions :: ListEngineVersions
- data ListEngineVersionsResponse = ListEngineVersionsResponse' (Maybe Text) (Maybe [EngineVersion]) Int
- newListEngineVersionsResponse :: Int -> ListEngineVersionsResponse
- data GetDataCatalog = GetDataCatalog' Text
- newGetDataCatalog :: Text -> GetDataCatalog
- data GetDataCatalogResponse = GetDataCatalogResponse' (Maybe DataCatalog) Int
- newGetDataCatalogResponse :: Int -> GetDataCatalogResponse
- 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 GetWorkGroup = GetWorkGroup' Text
- newGetWorkGroup :: Text -> GetWorkGroup
- data GetWorkGroupResponse = GetWorkGroupResponse' (Maybe WorkGroup) Int
- newGetWorkGroupResponse :: Int -> GetWorkGroupResponse
- data GetDatabase = GetDatabase' Text Text
- newGetDatabase :: Text -> Text -> GetDatabase
- data GetDatabaseResponse = GetDatabaseResponse' (Maybe Database) Int
- newGetDatabaseResponse :: Int -> GetDatabaseResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data GetPreparedStatement = GetPreparedStatement' Text Text
- newGetPreparedStatement :: Text -> Text -> GetPreparedStatement
- data GetPreparedStatementResponse = GetPreparedStatementResponse' (Maybe PreparedStatement) Int
- newGetPreparedStatementResponse :: Int -> GetPreparedStatementResponse
- data GetQueryResults = GetQueryResults' (Maybe Text) (Maybe Natural) Text
- newGetQueryResults :: Text -> GetQueryResults
- data GetQueryResultsResponse = GetQueryResultsResponse' (Maybe Integer) (Maybe Text) (Maybe ResultSet) Int
- newGetQueryResultsResponse :: Int -> GetQueryResultsResponse
- data ListTableMetadata = ListTableMetadata' (Maybe Text) (Maybe Text) (Maybe Natural) Text Text
- newListTableMetadata :: Text -> Text -> ListTableMetadata
- data ListTableMetadataResponse = ListTableMetadataResponse' (Maybe Text) (Maybe [TableMetadata]) Int
- newListTableMetadataResponse :: Int -> ListTableMetadataResponse
- data ListQueryExecutions = ListQueryExecutions' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListQueryExecutions :: ListQueryExecutions
- data ListQueryExecutionsResponse = ListQueryExecutionsResponse' (Maybe (NonEmpty Text)) (Maybe Text) Int
- newListQueryExecutionsResponse :: Int -> ListQueryExecutionsResponse
- data DeletePreparedStatement = DeletePreparedStatement' Text Text
- newDeletePreparedStatement :: Text -> Text -> DeletePreparedStatement
- data DeletePreparedStatementResponse = DeletePreparedStatementResponse' Int
- newDeletePreparedStatementResponse :: Int -> DeletePreparedStatementResponse
- data UpdatePreparedStatement = UpdatePreparedStatement' (Maybe Text) Text Text Text
- newUpdatePreparedStatement :: Text -> Text -> Text -> UpdatePreparedStatement
- data UpdatePreparedStatementResponse = UpdatePreparedStatementResponse' Int
- newUpdatePreparedStatementResponse :: Int -> UpdatePreparedStatementResponse
- 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 QueryExecutionState where
- QueryExecutionState' { }
- pattern QueryExecutionState_CANCELLED :: QueryExecutionState
- pattern QueryExecutionState_FAILED :: QueryExecutionState
- pattern QueryExecutionState_QUEUED :: QueryExecutionState
- pattern QueryExecutionState_RUNNING :: QueryExecutionState
- pattern QueryExecutionState_SUCCEEDED :: QueryExecutionState
- 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 Column = Column' (Maybe Text) (Maybe Text) Text
- newColumn :: Text -> Column
- data ColumnInfo = ColumnInfo' (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ColumnNullable) Text Text
- newColumnInfo :: Text -> Text -> ColumnInfo
- data DataCatalog = DataCatalog' (Maybe (HashMap Text Text)) (Maybe Text) Text DataCatalogType
- newDataCatalog :: Text -> DataCatalogType -> DataCatalog
- data DataCatalogSummary = DataCatalogSummary' (Maybe Text) (Maybe DataCatalogType)
- newDataCatalogSummary :: DataCatalogSummary
- data Database = Database' (Maybe (HashMap Text Text)) (Maybe Text) Text
- newDatabase :: Text -> Database
- data Datum = Datum' (Maybe Text)
- newDatum :: Datum
- data EncryptionConfiguration = EncryptionConfiguration' (Maybe Text) EncryptionOption
- newEncryptionConfiguration :: EncryptionOption -> EncryptionConfiguration
- data EngineVersion = EngineVersion' (Maybe Text) (Maybe Text)
- newEngineVersion :: EngineVersion
- data NamedQuery = NamedQuery' (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text
- newNamedQuery :: Text -> Text -> Text -> NamedQuery
- data PreparedStatement = PreparedStatement' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newPreparedStatement :: PreparedStatement
- data PreparedStatementSummary = PreparedStatementSummary' (Maybe POSIX) (Maybe Text)
- newPreparedStatementSummary :: PreparedStatementSummary
- data QueryExecution = QueryExecution' (Maybe EngineVersion) (Maybe QueryExecutionStatus) (Maybe QueryExecutionContext) (Maybe ResultConfiguration) (Maybe Text) (Maybe StatementType) (Maybe QueryExecutionStatistics) (Maybe Text) (Maybe Text)
- newQueryExecution :: QueryExecution
- data QueryExecutionContext = QueryExecutionContext' (Maybe Text) (Maybe Text)
- newQueryExecutionContext :: QueryExecutionContext
- data QueryExecutionStatistics = QueryExecutionStatistics' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Integer)
- newQueryExecutionStatistics :: QueryExecutionStatistics
- data QueryExecutionStatus = QueryExecutionStatus' (Maybe QueryExecutionState) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newQueryExecutionStatus :: QueryExecutionStatus
- data ResultConfiguration = ResultConfiguration' (Maybe EncryptionConfiguration) (Maybe Text)
- newResultConfiguration :: ResultConfiguration
- data ResultConfigurationUpdates = ResultConfigurationUpdates' (Maybe Bool) (Maybe Bool) (Maybe EncryptionConfiguration) (Maybe Text)
- newResultConfigurationUpdates :: ResultConfigurationUpdates
- data ResultSet = ResultSet' (Maybe [Row]) (Maybe ResultSetMetadata)
- newResultSet :: ResultSet
- data ResultSetMetadata = ResultSetMetadata' (Maybe [ColumnInfo])
- newResultSetMetadata :: ResultSetMetadata
- data Row = Row' (Maybe [Datum])
- newRow :: Row
- data TableMetadata = TableMetadata' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Column]) (Maybe POSIX) (Maybe [Column]) (Maybe POSIX) 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 UnprocessedQueryExecutionId = UnprocessedQueryExecutionId' (Maybe Text) (Maybe Text) (Maybe Text)
- newUnprocessedQueryExecutionId :: UnprocessedQueryExecutionId
- data WorkGroup = WorkGroup' (Maybe POSIX) (Maybe WorkGroupState) (Maybe WorkGroupConfiguration) (Maybe Text) Text
- newWorkGroup :: Text -> WorkGroup
- data WorkGroupConfiguration = WorkGroupConfiguration' (Maybe EngineVersion) (Maybe Bool) (Maybe ResultConfiguration) (Maybe Natural) (Maybe Bool) (Maybe Bool)
- newWorkGroupConfiguration :: WorkGroupConfiguration
- data WorkGroupConfigurationUpdates = WorkGroupConfigurationUpdates' (Maybe EngineVersion) (Maybe Bool) (Maybe ResultConfigurationUpdates) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newWorkGroupConfigurationUpdates :: WorkGroupConfigurationUpdates
- data WorkGroupSummary = WorkGroupSummary' (Maybe POSIX) (Maybe EngineVersion) (Maybe WorkGroupState) (Maybe Text) (Maybe Text)
- 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.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
MetadataException
_MetadataException :: AsError a => Getting (First ServiceError) 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.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the request was throttled.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates a platform issue, which may be due to a transient condition or outage.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A resource, such as a workgroup, was not found.
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.
ListDatabases (Paginated)
data ListDatabases Source #
See: newListDatabases smart constructor.
Instances
Arguments
| :: Text | |
| -> ListDatabases |
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:nextToken: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.
$sel:maxResults:ListDatabases', listDatabases_maxResults - Specifies the maximum number of results to return.
$sel:catalogName: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.
$sel:nextToken: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.
CreatePreparedStatement
data CreatePreparedStatement Source #
See: newCreatePreparedStatement smart constructor.
Instances
newCreatePreparedStatement Source #
Arguments
| :: 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:
$sel:description:CreatePreparedStatement', createPreparedStatement_description - The description of the prepared statement.
$sel:statementName:CreatePreparedStatement', createPreparedStatement_statementName - The name of the prepared statement.
$sel:workGroup:CreatePreparedStatement', createPreparedStatement_workGroup - The name of the workgroup to which the prepared statement belongs.
$sel:queryStatement:CreatePreparedStatement', createPreparedStatement_queryStatement - The query string for the prepared statement.
data CreatePreparedStatementResponse Source #
See: newCreatePreparedStatementResponse smart constructor.
Constructors
| CreatePreparedStatementResponse' Int |
Instances
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.
DeleteWorkGroup
data DeleteWorkGroup Source #
See: newDeleteWorkGroup smart constructor.
Constructors
| DeleteWorkGroup' (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> DeleteWorkGroup |
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.
$sel:workGroup:DeleteWorkGroup', deleteWorkGroup_workGroup - The unique name of the workgroup to delete.
data DeleteWorkGroupResponse Source #
See: newDeleteWorkGroupResponse smart constructor.
Constructors
| DeleteWorkGroupResponse' Int |
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.
UpdateWorkGroup
data UpdateWorkGroup Source #
See: newUpdateWorkGroup smart constructor.
Constructors
| UpdateWorkGroup' (Maybe WorkGroupState) (Maybe WorkGroupConfigurationUpdates) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> UpdateWorkGroup |
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:state:UpdateWorkGroup', updateWorkGroup_state - The workgroup state that will be updated for the given workgroup.
$sel:configurationUpdates:UpdateWorkGroup', updateWorkGroup_configurationUpdates - The workgroup configuration that will be updated for the given
workgroup.
$sel:description:UpdateWorkGroup', updateWorkGroup_description - The workgroup description.
$sel:workGroup:UpdateWorkGroup', updateWorkGroup_workGroup - The specified workgroup that will be updated.
data UpdateWorkGroupResponse Source #
See: newUpdateWorkGroupResponse smart constructor.
Constructors
| UpdateWorkGroupResponse' Int |
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.
GetNamedQuery
data GetNamedQuery Source #
See: newGetNamedQuery smart constructor.
Constructors
| GetNamedQuery' Text |
Instances
Arguments
| :: Text | |
| -> GetNamedQuery |
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:
$sel:namedQueryId:GetNamedQuery', getNamedQuery_namedQueryId - The unique ID of the query. Use ListNamedQueries to get query IDs.
data GetNamedQueryResponse Source #
See: newGetNamedQueryResponse smart constructor.
Constructors
| GetNamedQueryResponse' (Maybe NamedQuery) Int |
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.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
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:nextToken: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:maxResults:ListTagsForResource', listTagsForResource_maxResults - The maximum number of results to be returned per request that lists the
tags for the resource.
$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:
$sel:nextToken: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.
DeleteDataCatalog
data DeleteDataCatalog Source #
See: newDeleteDataCatalog smart constructor.
Constructors
| DeleteDataCatalog' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDataCatalog |
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:
$sel:name:DeleteDataCatalog', deleteDataCatalog_name - The name of the data catalog to delete.
data DeleteDataCatalogResponse Source #
See: newDeleteDataCatalogResponse smart constructor.
Constructors
| DeleteDataCatalogResponse' Int |
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.
UpdateDataCatalog
data UpdateDataCatalog Source #
See: newUpdateDataCatalog smart constructor.
Constructors
| UpdateDataCatalog' (Maybe (HashMap Text Text)) (Maybe Text) Text DataCatalogType |
Instances
Arguments
| :: Text | |
| -> DataCatalogType | |
| -> UpdateDataCatalog |
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:
$sel:parameters: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
HIVEdata catalog type, use the following syntax. Themetadata-functionparameter is required.The sdk-versionparameter is optional and defaults to the currently supported version.metadata-function=lambda_arn, sdk-version=version_number
For the
LAMBDAdata catalog type, use one of the following sets of required parameters, but not both.If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_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
$sel:description:UpdateDataCatalog', updateDataCatalog_description - New or modified text that describes the data catalog.
$sel:name: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 128
alphanumeric, underscore, at sign, or hyphen characters.
$sel:type':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.
Constructors
| UpdateDataCatalogResponse' Int |
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.
ListDataCatalogs (Paginated)
data ListDataCatalogs Source #
See: newListDataCatalogs smart constructor.
Constructors
| ListDataCatalogs' (Maybe Text) (Maybe Natural) |
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:nextToken: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.
$sel:maxResults:ListDataCatalogs', listDataCatalogs_maxResults - Specifies the maximum number of data catalogs to return.
data ListDataCatalogsResponse Source #
See: newListDataCatalogsResponse smart constructor.
Constructors
| ListDataCatalogsResponse' (Maybe [DataCatalogSummary]) (Maybe Text) Int |
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.
$sel:nextToken: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.
CreateNamedQuery
data CreateNamedQuery Source #
See: newCreateNamedQuery smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateNamedQuery |
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.
$sel:description:CreateNamedQuery', createNamedQuery_description - The query description.
$sel:workGroup:CreateNamedQuery', createNamedQuery_workGroup - The name of the workgroup in which the named query is being created.
$sel:name:CreateNamedQuery', createNamedQuery_name - The query name.
$sel:database:CreateNamedQuery', createNamedQuery_database - The database to which the query belongs.
$sel:queryString:CreateNamedQuery', createNamedQuery_queryString - The contents of the query with all query statements.
data CreateNamedQueryResponse Source #
See: newCreateNamedQueryResponse smart constructor.
Constructors
| CreateNamedQueryResponse' (Maybe Text) Int |
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:
$sel:namedQueryId:CreateNamedQueryResponse', createNamedQueryResponse_namedQueryId - The unique ID of the query.
$sel:httpStatus:CreateNamedQueryResponse', createNamedQueryResponse_httpStatus - The response's http status code.
GetTableMetadata
data GetTableMetadata Source #
See: newGetTableMetadata smart constructor.
Constructors
| GetTableMetadata' Text Text Text |
Instances
Arguments
| :: 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:
$sel:catalogName: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.
$sel:tableName:GetTableMetadata', getTableMetadata_tableName - The name of the table for which metadata is returned.
data GetTableMetadataResponse Source #
See: newGetTableMetadataResponse smart constructor.
Constructors
| GetTableMetadataResponse' (Maybe TableMetadata) Int |
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.
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:nextToken: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.
$sel:workGroup: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.
$sel:maxResults:ListNamedQueries', listNamedQueries_maxResults - The maximum number of queries to return in this request.
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:nextToken: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:namedQueryIds:ListNamedQueriesResponse', listNamedQueriesResponse_namedQueryIds - The list of unique query IDs.
$sel:httpStatus:ListNamedQueriesResponse', listNamedQueriesResponse_httpStatus - The response's http status code.
DeleteNamedQuery
data DeleteNamedQuery Source #
See: newDeleteNamedQuery smart constructor.
Constructors
| DeleteNamedQuery' Text |
Instances
Arguments
| :: Text | |
| -> DeleteNamedQuery |
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:
$sel:namedQueryId:DeleteNamedQuery', deleteNamedQuery_namedQueryId - The unique ID of the query to delete.
data DeleteNamedQueryResponse Source #
See: newDeleteNamedQueryResponse smart constructor.
Constructors
| DeleteNamedQueryResponse' Int |
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.
StartQueryExecution
data StartQueryExecution Source #
See: newStartQueryExecution smart constructor.
Constructors
| StartQueryExecution' (Maybe QueryExecutionContext) (Maybe ResultConfiguration) (Maybe Text) (Maybe Text) Text |
Instances
newStartQueryExecution Source #
Arguments
| :: Text | |
| -> StartQueryExecution |
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:queryExecutionContext:StartQueryExecution', startQueryExecution_queryExecutionContext - The database within which the query executes.
$sel:resultConfiguration: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.
$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.
$sel:workGroup:StartQueryExecution', startQueryExecution_workGroup - The name of the workgroup in which the query is being started.
$sel:queryString:StartQueryExecution', startQueryExecution_queryString - The SQL query statements to be executed.
data StartQueryExecutionResponse Source #
See: newStartQueryExecutionResponse smart constructor.
Constructors
| StartQueryExecutionResponse' (Maybe Text) Int |
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:
$sel:queryExecutionId: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.
BatchGetNamedQuery
data BatchGetNamedQuery Source #
See: newBatchGetNamedQuery smart constructor.
Constructors
| BatchGetNamedQuery' (NonEmpty Text) |
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.
Constructors
| BatchGetNamedQueryResponse' (Maybe [NamedQuery]) (Maybe [UnprocessedNamedQueryId]) Int |
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.
GetQueryExecution
data GetQueryExecution Source #
See: newGetQueryExecution smart constructor.
Constructors
| GetQueryExecution' Text |
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:
$sel:queryExecutionId:GetQueryExecution', getQueryExecution_queryExecutionId - The unique ID of the query execution.
data GetQueryExecutionResponse Source #
See: newGetQueryExecutionResponse smart constructor.
Constructors
| GetQueryExecutionResponse' (Maybe QueryExecution) Int |
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.
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:nextToken: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.
$sel:maxResults:ListPreparedStatements', listPreparedStatements_maxResults - The maximum number of results to return in this request.
$sel:workGroup:ListPreparedStatements', listPreparedStatements_workGroup - The workgroup to list the prepared statements for.
data ListPreparedStatementsResponse Source #
See: newListPreparedStatementsResponse smart constructor.
Constructors
| ListPreparedStatementsResponse' (Maybe [PreparedStatementSummary]) (Maybe Text) Int |
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:
$sel:preparedStatements:ListPreparedStatementsResponse', listPreparedStatementsResponse_preparedStatements - The list of prepared statements for the workgroup.
$sel:nextToken: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:httpStatus:ListPreparedStatementsResponse', listPreparedStatementsResponse_httpStatus - The response's http status code.
CreateDataCatalog
data CreateDataCatalog Source #
See: newCreateDataCatalog smart constructor.
Constructors
| CreateDataCatalog' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Tag]) Text DataCatalogType |
Instances
Arguments
| :: Text | |
| -> DataCatalogType | |
| -> CreateDataCatalog |
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:
$sel:parameters: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
HIVEdata catalog type, use the following syntax. Themetadata-functionparameter is required.The sdk-versionparameter is optional and defaults to the currently supported version.metadata-function=lambda_arn, sdk-version=version_number
For the
LAMBDAdata catalog type, use one of the following sets of required parameters, but not both.If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_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
GLUEtype takes a catalog ID parameter and is required. Thecatalog_idis the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.catalog-id=catalog_id
- The
GLUEdata catalog type also applies to the defaultAwsDataCatalogthat already exists in your account, of which you can have only one and cannot modify. - Queries that specify a Glue Data Catalog other than the default
AwsDataCatalogmust be run on Athena engine version 2. - In Regions where Athena engine version 2 is not available,
creating new Glue data catalogs results in an
INVALID_INPUTerror.
- The
$sel:description:CreateDataCatalog', createDataCatalog_description - A description of the data catalog to be created.
$sel:tags:CreateDataCatalog', createDataCatalog_tags - A list of comma separated tags to add to the data catalog that is
created.
$sel:name: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 128
alphanumeric, underscore, at sign, or hyphen characters.
$sel:type':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.
Constructors
| CreateDataCatalogResponse' Int |
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.
ListWorkGroups
data ListWorkGroups Source #
See: newListWorkGroups smart constructor.
Constructors
| ListWorkGroups' (Maybe Text) (Maybe Natural) |
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:nextToken: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.
$sel:maxResults:ListWorkGroups', listWorkGroups_maxResults - The maximum number of workgroups to return in this request.
data ListWorkGroupsResponse Source #
See: newListWorkGroupsResponse smart constructor.
Constructors
| ListWorkGroupsResponse' (Maybe Text) (Maybe [WorkGroupSummary]) Int |
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:
$sel:nextToken: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.
CreateWorkGroup
data CreateWorkGroup Source #
See: newCreateWorkGroup smart constructor.
Constructors
| CreateWorkGroup' (Maybe WorkGroupConfiguration) (Maybe Text) (Maybe [Tag]) Text |
Instances
Arguments
| :: Text | |
| -> CreateWorkGroup |
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:
$sel:configuration:CreateWorkGroup', createWorkGroup_configuration - The configuration for the workgroup, which includes the location in
Amazon S3 where query results are stored, the encryption configuration,
if any, used for encrypting query results, whether the Amazon CloudWatch
Metrics are enabled for the workgroup, the limit for the amount of bytes
scanned (cutoff) per query, if it is specified, and whether workgroup's
settings (specified with EnforceWorkGroupConfiguration) in the
WorkGroupConfiguration override client-side settings. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
$sel:description: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.
$sel:name:CreateWorkGroup', createWorkGroup_name - The workgroup name.
data CreateWorkGroupResponse Source #
See: newCreateWorkGroupResponse smart constructor.
Constructors
| CreateWorkGroupResponse' Int |
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.
BatchGetQueryExecution
data BatchGetQueryExecution Source #
See: newBatchGetQueryExecution smart constructor.
Constructors
| BatchGetQueryExecution' (NonEmpty Text) |
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.
Constructors
| BatchGetQueryExecutionResponse' (Maybe [UnprocessedQueryExecutionId]) (Maybe [QueryExecution]) Int |
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:unprocessedQueryExecutionIds:BatchGetQueryExecutionResponse', batchGetQueryExecutionResponse_unprocessedQueryExecutionIds - Information about the query executions that failed to run.
$sel:queryExecutions:BatchGetQueryExecutionResponse', batchGetQueryExecutionResponse_queryExecutions - Information about a query execution.
$sel:httpStatus:BatchGetQueryExecutionResponse', batchGetQueryExecutionResponse_httpStatus - The response's http status code.
ListEngineVersions
data ListEngineVersions Source #
See: newListEngineVersions smart constructor.
Constructors
| ListEngineVersions' (Maybe Text) (Maybe Natural) |
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:nextToken: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.
$sel:maxResults:ListEngineVersions', listEngineVersions_maxResults - The maximum number of engine versions to return in this request.
data ListEngineVersionsResponse Source #
See: newListEngineVersionsResponse smart constructor.
Constructors
| ListEngineVersionsResponse' (Maybe Text) (Maybe [EngineVersion]) Int |
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:nextToken: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:engineVersions:ListEngineVersionsResponse', listEngineVersionsResponse_engineVersions - A list of engine versions that are available to choose from.
$sel:httpStatus:ListEngineVersionsResponse', listEngineVersionsResponse_httpStatus - The response's http status code.
GetDataCatalog
data GetDataCatalog Source #
See: newGetDataCatalog smart constructor.
Constructors
| GetDataCatalog' Text |
Instances
Arguments
| :: Text | |
| -> GetDataCatalog |
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:
$sel:name:GetDataCatalog', getDataCatalog_name - The name of the data catalog to return.
data GetDataCatalogResponse Source #
See: newGetDataCatalogResponse smart constructor.
Constructors
| GetDataCatalogResponse' (Maybe DataCatalog) Int |
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.
StopQueryExecution
data StopQueryExecution Source #
See: newStopQueryExecution smart constructor.
Constructors
| StopQueryExecution' Text |
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:
$sel:queryExecutionId:StopQueryExecution', stopQueryExecution_queryExecutionId - The unique ID of the query execution to stop.
data StopQueryExecutionResponse Source #
See: newStopQueryExecutionResponse smart constructor.
Constructors
| StopQueryExecutionResponse' Int |
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.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
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.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
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.
GetWorkGroup
data GetWorkGroup Source #
See: newGetWorkGroup smart constructor.
Constructors
| GetWorkGroup' Text |
Instances
Arguments
| :: Text | |
| -> GetWorkGroup |
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:
$sel:workGroup:GetWorkGroup', getWorkGroup_workGroup - The name of the workgroup.
data GetWorkGroupResponse Source #
See: newGetWorkGroupResponse smart constructor.
Constructors
| GetWorkGroupResponse' (Maybe WorkGroup) Int |
Instances
newGetWorkGroupResponse Source #
Arguments
| :: Int | |
| -> GetWorkGroupResponse |
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:
$sel:workGroup:GetWorkGroup', getWorkGroupResponse_workGroup - Information about the workgroup.
$sel:httpStatus:GetWorkGroupResponse', getWorkGroupResponse_httpStatus - The response's http status code.
GetDatabase
data GetDatabase Source #
See: newGetDatabase smart constructor.
Constructors
| GetDatabase' Text Text |
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:
$sel:catalogName: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.
Constructors
| GetDatabaseResponse' (Maybe Database) Int |
Instances
newGetDatabaseResponse Source #
Arguments
| :: Int | |
| -> GetDatabaseResponse |
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:
$sel:database:GetDatabaseResponse', getDatabaseResponse_database - The database returned.
$sel:httpStatus:GetDatabaseResponse', getDatabaseResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
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.
Constructors
| UntagResourceResponse' Int |
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.
GetPreparedStatement
data GetPreparedStatement Source #
See: newGetPreparedStatement smart constructor.
Constructors
| GetPreparedStatement' Text Text |
Instances
newGetPreparedStatement Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetPreparedStatement |
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:
$sel:statementName:GetPreparedStatement', getPreparedStatement_statementName - The name of the prepared statement to retrieve.
$sel:workGroup:GetPreparedStatement', getPreparedStatement_workGroup - The workgroup to which the statement to be retrieved belongs.
data GetPreparedStatementResponse Source #
See: newGetPreparedStatementResponse smart constructor.
Constructors
| GetPreparedStatementResponse' (Maybe PreparedStatement) Int |
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.
GetQueryResults (Paginated)
data GetQueryResults Source #
See: newGetQueryResults smart constructor.
Instances
Arguments
| :: Text | |
| -> GetQueryResults |
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:nextToken: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.
$sel:maxResults:GetQueryResults', getQueryResults_maxResults - The maximum number of results (rows) to return in this request.
$sel:queryExecutionId: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:
$sel:updateCount:GetQueryResultsResponse', getQueryResultsResponse_updateCount - The number of rows inserted with a CREATE TABLE AS SELECT statement.
$sel:nextToken: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:httpStatus:GetQueryResultsResponse', getQueryResultsResponse_httpStatus - The response's http status code.
ListTableMetadata (Paginated)
data ListTableMetadata Source #
See: newListTableMetadata smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListTableMetadata |
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:nextToken: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.
$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.
$sel:catalogName: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.
Constructors
| ListTableMetadataResponse' (Maybe Text) (Maybe [TableMetadata]) Int |
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:
$sel:nextToken: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.
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:nextToken: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.
$sel:workGroup: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.
$sel:maxResults:ListQueryExecutions', listQueryExecutions_maxResults - The maximum number of query executions to return in this request.
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:
$sel:queryExecutionIds:ListQueryExecutionsResponse', listQueryExecutionsResponse_queryExecutionIds - The unique IDs of each query execution as an array of strings.
$sel:nextToken:ListQueryExecutions', listQueryExecutionsResponse_nextToken - A token to be used by the next request if this request is truncated.
$sel:httpStatus:ListQueryExecutionsResponse', listQueryExecutionsResponse_httpStatus - The response's http status code.
DeletePreparedStatement
data DeletePreparedStatement Source #
See: newDeletePreparedStatement smart constructor.
Constructors
| DeletePreparedStatement' Text Text |
Instances
newDeletePreparedStatement Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeletePreparedStatement |
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:
$sel:statementName:DeletePreparedStatement', deletePreparedStatement_statementName - The name of the prepared statement to delete.
$sel:workGroup:DeletePreparedStatement', deletePreparedStatement_workGroup - The workgroup to which the statement to be deleted belongs.
data DeletePreparedStatementResponse Source #
See: newDeletePreparedStatementResponse smart constructor.
Constructors
| DeletePreparedStatementResponse' Int |
Instances
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.
UpdatePreparedStatement
data UpdatePreparedStatement Source #
See: newUpdatePreparedStatement smart constructor.
Instances
newUpdatePreparedStatement Source #
Arguments
| :: 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:
$sel:description:UpdatePreparedStatement', updatePreparedStatement_description - The description of the prepared statement.
$sel:statementName:UpdatePreparedStatement', updatePreparedStatement_statementName - The name of the prepared statement.
$sel:workGroup:UpdatePreparedStatement', updatePreparedStatement_workGroup - The workgroup for the prepared statement.
$sel:queryStatement:UpdatePreparedStatement', updatePreparedStatement_queryStatement - The query string for the prepared statement.
data UpdatePreparedStatementResponse Source #
See: newUpdatePreparedStatementResponse smart constructor.
Constructors
| UpdatePreparedStatementResponse' Int |
Instances
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.
Types
ColumnNullable
newtype ColumnNullable Source #
Constructors
| ColumnNullable' | |
Fields | |
Bundled Patterns
| pattern ColumnNullable_NOT_NULL :: ColumnNullable | |
| pattern ColumnNullable_NULLABLE :: ColumnNullable | |
| pattern ColumnNullable_UNKNOWN :: ColumnNullable |
Instances
DataCatalogType
newtype DataCatalogType Source #
Constructors
| DataCatalogType' | |
Fields | |
Bundled Patterns
| pattern DataCatalogType_GLUE :: DataCatalogType | |
| pattern DataCatalogType_HIVE :: DataCatalogType | |
| pattern DataCatalogType_LAMBDA :: DataCatalogType |
Instances
EncryptionOption
newtype EncryptionOption Source #
Constructors
| EncryptionOption' | |
Fields | |
Bundled Patterns
| pattern EncryptionOption_CSE_KMS :: EncryptionOption | |
| pattern EncryptionOption_SSE_KMS :: EncryptionOption | |
| pattern EncryptionOption_SSE_S3 :: EncryptionOption |
Instances
QueryExecutionState
newtype QueryExecutionState Source #
Constructors
| QueryExecutionState' | |
Fields | |
Bundled Patterns
| pattern QueryExecutionState_CANCELLED :: QueryExecutionState | |
| pattern QueryExecutionState_FAILED :: QueryExecutionState | |
| pattern QueryExecutionState_QUEUED :: QueryExecutionState | |
| pattern QueryExecutionState_RUNNING :: QueryExecutionState | |
| pattern QueryExecutionState_SUCCEEDED :: QueryExecutionState |
Instances
StatementType
newtype StatementType Source #
Constructors
| StatementType' | |
Fields | |
Bundled Patterns
| pattern StatementType_DDL :: StatementType | |
| pattern StatementType_DML :: StatementType | |
| pattern StatementType_UTILITY :: StatementType |
Instances
WorkGroupState
newtype WorkGroupState Source #
Constructors
| WorkGroupState' | |
Fields | |
Bundled Patterns
| pattern WorkGroupState_DISABLED :: WorkGroupState | |
| pattern WorkGroupState_ENABLED :: WorkGroupState |
Instances
Column
Contains metadata for a column in a table.
See: newColumn smart constructor.
Instances
| Eq Column Source # | |
| Read Column Source # | |
| Show Column Source # | |
| Generic Column Source # | |
| NFData Column Source # | |
Defined in Amazonka.Athena.Types.Column | |
| Hashable Column Source # | |
Defined in Amazonka.Athena.Types.Column | |
| FromJSON Column Source # | |
| type Rep Column Source # | |
Defined in Amazonka.Athena.Types.Column type Rep Column = D1 ('MetaData "Column" "Amazonka.Athena.Types.Column" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "Column'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "comment") '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:type':Column', column_type - The data type of the column.
$sel:comment:Column', column_comment - Optional information about the column.
$sel:name:Column', column_name - The name of the column.
ColumnInfo
data ColumnInfo Source #
Information about the columns in a query execution result.
See: newColumnInfo smart constructor.
Constructors
| ColumnInfo' (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ColumnNullable) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ColumnInfo |
Create a value of ColumnInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel: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: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:schemaName:ColumnInfo', columnInfo_schemaName - The schema name (database name) to which the query results belong.
$sel:catalogName:ColumnInfo', columnInfo_catalogName - The catalog to which the query results belong.
$sel:caseSensitive:ColumnInfo', columnInfo_caseSensitive - Indicates whether values in the column are case-sensitive.
$sel:label:ColumnInfo', columnInfo_label - A column label.
$sel:tableName:ColumnInfo', columnInfo_tableName - The table name for the query results.
$sel:nullable:ColumnInfo', columnInfo_nullable - Indicates the column's nullable status.
$sel:name:ColumnInfo', columnInfo_name - The name of the column.
$sel:type':ColumnInfo', columnInfo_type - The data type of the column.
DataCatalog
data DataCatalog Source #
Contains information about a data catalog in an Amazon Web Services account.
See: newDataCatalog smart constructor.
Constructors
| DataCatalog' (Maybe (HashMap Text Text)) (Maybe Text) Text DataCatalogType |
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:parameters:DataCatalog', dataCatalog_parameters - Specifies the Lambda function or functions to use for the data catalog.
This is a mapping whose values depend on the catalog type.
For the
HIVEdata catalog type, use the following syntax. Themetadata-functionparameter is required.The sdk-versionparameter is optional and defaults to the currently supported version.metadata-function=lambda_arn, sdk-version=version_number
For the
LAMBDAdata catalog type, use one of the following sets of required parameters, but not both.If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_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
GLUEtype takes a catalog ID parameter and is required. Thecatalog_idis the account ID of the Amazon Web Services account to which the Glue catalog belongs.catalog-id=catalog_id
- The
GLUEdata catalog type also applies to the defaultAwsDataCatalogthat already exists in your account, of which you can have only one and cannot modify. - Queries that specify a Glue Data Catalog other than the default
AwsDataCatalogmust be run on Athena engine version 2.
- The
$sel:description:DataCatalog', dataCatalog_description - An optional description of the data catalog.
$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 128 alphanumeric,
underscore, at sign, or hyphen characters.
$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.
Constructors
| DataCatalogSummary' (Maybe Text) (Maybe DataCatalogType) |
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.
$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
| Eq Database Source # | |
| Read Database Source # | |
| Show Database Source # | |
| Generic Database Source # | |
| NFData Database Source # | |
Defined in Amazonka.Athena.Types.Database | |
| Hashable Database Source # | |
Defined in Amazonka.Athena.Types.Database | |
| FromJSON Database Source # | |
| type Rep Database Source # | |
Defined in Amazonka.Athena.Types.Database type Rep Database = D1 ('MetaData "Database" "Amazonka.Athena.Types.Database" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "Database'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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:parameters:Database', database_parameters - A set of custom key/value pairs.
$sel:description:Database', database_description - An optional description of the database.
$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.
Constructors
| EncryptionConfiguration' (Maybe Text) EncryptionOption |
Instances
newEncryptionConfiguration Source #
Arguments
| :: EncryptionOption | |
| -> EncryptionConfiguration |
Create a value of EncryptionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:EncryptionConfiguration', encryptionConfiguration_kmsKey - For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.
$sel:encryptionOption:EncryptionConfiguration', encryptionConfiguration_encryptionOption - Indicates whether Amazon S3 server-side encryption with Amazon
S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys
(SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS)
is used.
If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
EngineVersion
data EngineVersion Source #
The Athena engine version for running queries.
See: newEngineVersion smart constructor.
Constructors
| 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.
NamedQuery
data NamedQuery Source #
A query, where QueryString is the list of SQL query statements that
comprise the query.
See: newNamedQuery smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> NamedQuery |
Create a value of NamedQuery with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namedQueryId:NamedQuery', namedQuery_namedQueryId - The unique identifier of the query.
$sel:description:NamedQuery', namedQuery_description - The query description.
$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 query statements that comprise the query.
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: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:description:PreparedStatement', preparedStatement_description - The description 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.
Constructors
| PreparedStatementSummary' (Maybe POSIX) (Maybe Text) |
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.
Constructors
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:status:QueryExecution', queryExecution_status - The completion date, current state, submission time, and state change
reason (if applicable) for the query execution.
$sel:queryExecutionContext:QueryExecution', queryExecution_queryExecutionContext - The database in which the query execution occurred.
$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:query:QueryExecution', queryExecution_query - The SQL query statements which the query execution ran.
$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:queryExecutionId:QueryExecution', queryExecution_queryExecutionId - The unique identifier for each 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.
Constructors
| QueryExecutionContext' (Maybe Text) (Maybe Text) |
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:database:QueryExecutionContext', queryExecutionContext_database - The name of the database used in the query execution. The database must
exist in the catalog.
$sel:catalog:QueryExecutionContext', queryExecutionContext_catalog - The name of the data catalog used in the query execution.
QueryExecutionStatistics
data QueryExecutionStatistics Source #
The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.
See: newQueryExecutionStatistics smart constructor.
Constructors
| QueryExecutionStatistics' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Text) (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:totalExecutionTimeInMillis:QueryExecutionStatistics', queryExecutionStatistics_totalExecutionTimeInMillis - The number of milliseconds that Athena took to run the query.
$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:dataScannedInBytes:QueryExecutionStatistics', queryExecutionStatistics_dataScannedInBytes - The number of bytes in the data that was queried.
$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: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: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.
QueryExecutionStatus
data QueryExecutionStatus Source #
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
See: newQueryExecutionStatus smart constructor.
Constructors
| QueryExecutionStatus' (Maybe QueryExecutionState) (Maybe Text) (Maybe POSIX) (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: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.
$sel:completionDateTime:QueryExecutionStatus', queryExecutionStatus_completionDateTime - The date and time that the query completed.
ResultConfiguration
data ResultConfiguration Source #
The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.
See: newResultConfiguration smart constructor.
Constructors
| ResultConfiguration' (Maybe EncryptionConfiguration) (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: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: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.
Constructors
| ResultConfigurationUpdates' (Maybe Bool) (Maybe Bool) (Maybe EncryptionConfiguration) (Maybe Text) |
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: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.
$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:encryptionConfiguration:ResultConfigurationUpdates', resultConfigurationUpdates_encryptionConfiguration - The encryption configuration for the query results.
$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.
ResultSet
The metadata and rows that comprise a query result set. The metadata
describes the column structure and data types. To return a ResultSet
object, use GetQueryResults.
See: newResultSet smart constructor.
Constructors
| ResultSet' (Maybe [Row]) (Maybe ResultSetMetadata) |
Instances
| Eq ResultSet Source # | |
| Read ResultSet Source # | |
| Show ResultSet Source # | |
| Generic ResultSet Source # | |
| NFData ResultSet Source # | |
Defined in Amazonka.Athena.Types.ResultSet | |
| Hashable ResultSet Source # | |
Defined in Amazonka.Athena.Types.ResultSet | |
| FromJSON ResultSet Source # | |
| type Rep ResultSet Source # | |
Defined in Amazonka.Athena.Types.ResultSet type Rep ResultSet = D1 ('MetaData "ResultSet" "Amazonka.Athena.Types.ResultSet" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "ResultSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Row])) :*: S1 ('MetaSel ('Just "resultSetMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResultSetMetadata)))) | |
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:rows:ResultSet', resultSet_rows - The rows in the table.
$sel:resultSetMetadata:ResultSet', resultSet_resultSetMetadata - The metadata that describes the column structure and data types of a
table of query results.
ResultSetMetadata
data ResultSetMetadata Source #
The metadata that describes the column structure and data types of a
table of query results. To return a ResultSetMetadata object, use
GetQueryResults.
See: newResultSetMetadata smart constructor.
Constructors
| ResultSetMetadata' (Maybe [ColumnInfo]) |
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 comprise 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.
TableMetadata
data TableMetadata Source #
Contains metadata for a table.
See: newTableMetadata smart constructor.
Constructors
| TableMetadata' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Column]) (Maybe POSIX) (Maybe [Column]) (Maybe POSIX) Text |
Instances
Arguments
| :: Text | |
| -> TableMetadata |
Create a value of TableMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableType:TableMetadata', tableMetadata_tableType - The type of table. In Athena, only EXTERNAL_TABLE is supported.
$sel:parameters:TableMetadata', tableMetadata_parameters - A set of custom key/value pairs for table properties.
$sel:columns:TableMetadata', tableMetadata_columns - A list of the columns in the table.
$sel:lastAccessTime:TableMetadata', tableMetadata_lastAccessTime - The last time the table was accessed.
$sel:partitionKeys:TableMetadata', tableMetadata_partitionKeys - A list of the partition keys in the table.
$sel:createTime:TableMetadata', tableMetadata_createTime - The time that the table was created.
$sel:name: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
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Athena.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.Athena.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.Athena.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.Athena.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Athena.Types.Tag" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") '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: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.
$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.
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:namedQueryId:UnprocessedNamedQueryId', unprocessedNamedQueryId_namedQueryId - The unique identifier of the named query.
$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.
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:queryExecutionId:UnprocessedQueryExecutionId', unprocessedQueryExecutionId_queryExecutionId - The unique identifier of the query execution.
$sel:errorMessage:UnprocessedQueryExecutionId', unprocessedQueryExecutionId_errorMessage - The error message returned when the query execution failed to process,
if applicable.
WorkGroup
A workgroup, which contains a name, description, creation time, state,
and other configuration, listed under WorkGroup$Configuration. Each
workgroup enables you to isolate queries for you or your group of users
from other queries in the same account, to configure the query results
location and the encryption configuration (known as workgroup settings),
to enable sending query metrics to Amazon CloudWatch, and to establish
per-query data usage control limits for all queries in a workgroup. The
workgroup settings override is specified in
EnforceWorkGroupConfiguration (true/false) in the
WorkGroupConfiguration. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
See: newWorkGroup smart constructor.
Constructors
| WorkGroup' (Maybe POSIX) (Maybe WorkGroupState) (Maybe WorkGroupConfiguration) (Maybe Text) Text |
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:creationTime:WorkGroup', workGroup_creationTime - The date and time the workgroup was created.
$sel:state:WorkGroup', workGroup_state - The state of the workgroup: ENABLED or DISABLED.
$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:description:WorkGroup', workGroup_description - The workgroup description.
$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.
Constructors
| WorkGroupConfiguration' (Maybe EngineVersion) (Maybe Bool) (Maybe ResultConfiguration) (Maybe Natural) (Maybe Bool) (Maybe Bool) |
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: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: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.
$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: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:publishCloudWatchMetricsEnabled:WorkGroupConfiguration', workGroupConfiguration_publishCloudWatchMetricsEnabled - Indicates that the Amazon CloudWatch metrics are enabled for the
workgroup.
WorkGroupConfigurationUpdates
data WorkGroupConfigurationUpdates Source #
The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.
See: newWorkGroupConfigurationUpdates smart constructor.
Constructors
| WorkGroupConfigurationUpdates' (Maybe EngineVersion) (Maybe Bool) (Maybe ResultConfigurationUpdates) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Bool) |
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: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: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.
$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:removeBytesScannedCutoffPerQuery:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_removeBytesScannedCutoffPerQuery - Indicates that the data usage control limit per query is removed.
WorkGroupConfiguration$BytesScannedCutoffPerQuery
$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:publishCloudWatchMetricsEnabled:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_publishCloudWatchMetricsEnabled - Indicates whether this workgroup enables publishing metrics to Amazon
CloudWatch.
WorkGroupSummary
data WorkGroupSummary Source #
The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.
See: newWorkGroupSummary smart constructor.
Constructors
| WorkGroupSummary' (Maybe POSIX) (Maybe EngineVersion) (Maybe WorkGroupState) (Maybe Text) (Maybe Text) |
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: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:state:WorkGroupSummary', workGroupSummary_state - The state of the workgroup.
$sel:name:WorkGroupSummary', workGroupSummary_name - The name of the workgroup.
$sel:description:WorkGroupSummary', workGroupSummary_description - The workgroup description.