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 |
- Service Configuration
- Errors
- 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
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
- 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' {}
- newColumn :: Text -> Column
- column_type :: Lens' Column (Maybe Text)
- column_comment :: Lens' Column (Maybe Text)
- column_name :: Lens' Column Text
- data ColumnInfo = ColumnInfo' {}
- newColumnInfo :: Text -> Text -> ColumnInfo
- columnInfo_scale :: Lens' ColumnInfo (Maybe Int)
- columnInfo_precision :: Lens' ColumnInfo (Maybe Int)
- columnInfo_schemaName :: Lens' ColumnInfo (Maybe Text)
- columnInfo_catalogName :: Lens' ColumnInfo (Maybe Text)
- columnInfo_caseSensitive :: Lens' ColumnInfo (Maybe Bool)
- columnInfo_label :: Lens' ColumnInfo (Maybe Text)
- columnInfo_tableName :: Lens' ColumnInfo (Maybe Text)
- columnInfo_nullable :: Lens' ColumnInfo (Maybe ColumnNullable)
- columnInfo_name :: Lens' ColumnInfo Text
- columnInfo_type :: Lens' ColumnInfo Text
- data DataCatalog = DataCatalog' {
- parameters :: Maybe (HashMap Text Text)
- description :: Maybe Text
- name :: Text
- type' :: DataCatalogType
- newDataCatalog :: Text -> DataCatalogType -> DataCatalog
- dataCatalog_parameters :: Lens' DataCatalog (Maybe (HashMap Text Text))
- dataCatalog_description :: Lens' DataCatalog (Maybe Text)
- dataCatalog_name :: Lens' DataCatalog Text
- dataCatalog_type :: Lens' DataCatalog DataCatalogType
- data DataCatalogSummary = DataCatalogSummary' {}
- newDataCatalogSummary :: DataCatalogSummary
- dataCatalogSummary_catalogName :: Lens' DataCatalogSummary (Maybe Text)
- dataCatalogSummary_type :: Lens' DataCatalogSummary (Maybe DataCatalogType)
- data Database = Database' {
- parameters :: Maybe (HashMap Text Text)
- description :: Maybe Text
- name :: Text
- newDatabase :: Text -> Database
- database_parameters :: Lens' Database (Maybe (HashMap Text Text))
- database_description :: Lens' Database (Maybe Text)
- database_name :: Lens' Database Text
- data Datum = Datum' {}
- newDatum :: Datum
- datum_varCharValue :: Lens' Datum (Maybe Text)
- data EncryptionConfiguration = EncryptionConfiguration' {}
- newEncryptionConfiguration :: EncryptionOption -> EncryptionConfiguration
- encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration (Maybe Text)
- encryptionConfiguration_encryptionOption :: Lens' EncryptionConfiguration EncryptionOption
- data EngineVersion = EngineVersion' {}
- newEngineVersion :: EngineVersion
- engineVersion_effectiveEngineVersion :: Lens' EngineVersion (Maybe Text)
- engineVersion_selectedEngineVersion :: Lens' EngineVersion (Maybe Text)
- data NamedQuery = NamedQuery' {
- namedQueryId :: Maybe Text
- description :: Maybe Text
- workGroup :: Maybe Text
- name :: Text
- database :: Text
- queryString :: Text
- newNamedQuery :: Text -> Text -> Text -> NamedQuery
- namedQuery_namedQueryId :: Lens' NamedQuery (Maybe Text)
- namedQuery_description :: Lens' NamedQuery (Maybe Text)
- namedQuery_workGroup :: Lens' NamedQuery (Maybe Text)
- namedQuery_name :: Lens' NamedQuery Text
- namedQuery_database :: Lens' NamedQuery Text
- namedQuery_queryString :: Lens' NamedQuery Text
- data PreparedStatement = PreparedStatement' {}
- newPreparedStatement :: PreparedStatement
- preparedStatement_lastModifiedTime :: Lens' PreparedStatement (Maybe UTCTime)
- preparedStatement_queryStatement :: Lens' PreparedStatement (Maybe Text)
- preparedStatement_statementName :: Lens' PreparedStatement (Maybe Text)
- preparedStatement_description :: Lens' PreparedStatement (Maybe Text)
- preparedStatement_workGroupName :: Lens' PreparedStatement (Maybe Text)
- data PreparedStatementSummary = PreparedStatementSummary' {}
- newPreparedStatementSummary :: PreparedStatementSummary
- preparedStatementSummary_lastModifiedTime :: Lens' PreparedStatementSummary (Maybe UTCTime)
- preparedStatementSummary_statementName :: Lens' PreparedStatementSummary (Maybe Text)
- data QueryExecution = QueryExecution' {
- engineVersion :: Maybe EngineVersion
- status :: Maybe QueryExecutionStatus
- queryExecutionContext :: Maybe QueryExecutionContext
- resultConfiguration :: Maybe ResultConfiguration
- query :: Maybe Text
- statementType :: Maybe StatementType
- statistics :: Maybe QueryExecutionStatistics
- queryExecutionId :: Maybe Text
- workGroup :: Maybe Text
- newQueryExecution :: QueryExecution
- queryExecution_engineVersion :: Lens' QueryExecution (Maybe EngineVersion)
- queryExecution_status :: Lens' QueryExecution (Maybe QueryExecutionStatus)
- queryExecution_queryExecutionContext :: Lens' QueryExecution (Maybe QueryExecutionContext)
- queryExecution_resultConfiguration :: Lens' QueryExecution (Maybe ResultConfiguration)
- queryExecution_query :: Lens' QueryExecution (Maybe Text)
- queryExecution_statementType :: Lens' QueryExecution (Maybe StatementType)
- queryExecution_statistics :: Lens' QueryExecution (Maybe QueryExecutionStatistics)
- queryExecution_queryExecutionId :: Lens' QueryExecution (Maybe Text)
- queryExecution_workGroup :: Lens' QueryExecution (Maybe Text)
- data QueryExecutionContext = QueryExecutionContext' {}
- newQueryExecutionContext :: QueryExecutionContext
- queryExecutionContext_database :: Lens' QueryExecutionContext (Maybe Text)
- queryExecutionContext_catalog :: Lens' QueryExecutionContext (Maybe Text)
- data QueryExecutionStatistics = QueryExecutionStatistics' {}
- newQueryExecutionStatistics :: QueryExecutionStatistics
- queryExecutionStatistics_totalExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_engineExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_queryPlanningTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_dataScannedInBytes :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_queryQueueTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- queryExecutionStatistics_dataManifestLocation :: Lens' QueryExecutionStatistics (Maybe Text)
- queryExecutionStatistics_serviceProcessingTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer)
- data QueryExecutionStatus = QueryExecutionStatus' {}
- newQueryExecutionStatus :: QueryExecutionStatus
- queryExecutionStatus_state :: Lens' QueryExecutionStatus (Maybe QueryExecutionState)
- queryExecutionStatus_stateChangeReason :: Lens' QueryExecutionStatus (Maybe Text)
- queryExecutionStatus_submissionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)
- queryExecutionStatus_completionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime)
- data ResultConfiguration = ResultConfiguration' {}
- newResultConfiguration :: ResultConfiguration
- resultConfiguration_encryptionConfiguration :: Lens' ResultConfiguration (Maybe EncryptionConfiguration)
- resultConfiguration_outputLocation :: Lens' ResultConfiguration (Maybe Text)
- data ResultConfigurationUpdates = ResultConfigurationUpdates' {}
- newResultConfigurationUpdates :: ResultConfigurationUpdates
- resultConfigurationUpdates_removeOutputLocation :: Lens' ResultConfigurationUpdates (Maybe Bool)
- resultConfigurationUpdates_removeEncryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool)
- resultConfigurationUpdates_encryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe EncryptionConfiguration)
- resultConfigurationUpdates_outputLocation :: Lens' ResultConfigurationUpdates (Maybe Text)
- data ResultSet = ResultSet' {}
- newResultSet :: ResultSet
- resultSet_rows :: Lens' ResultSet (Maybe [Row])
- resultSet_resultSetMetadata :: Lens' ResultSet (Maybe ResultSetMetadata)
- data ResultSetMetadata = ResultSetMetadata' {
- columnInfo :: Maybe [ColumnInfo]
- newResultSetMetadata :: ResultSetMetadata
- resultSetMetadata_columnInfo :: Lens' ResultSetMetadata (Maybe [ColumnInfo])
- data Row = Row' {}
- newRow :: Row
- row_data :: Lens' Row (Maybe [Datum])
- data TableMetadata = TableMetadata' {}
- newTableMetadata :: Text -> TableMetadata
- tableMetadata_tableType :: Lens' TableMetadata (Maybe Text)
- tableMetadata_parameters :: Lens' TableMetadata (Maybe (HashMap Text Text))
- tableMetadata_columns :: Lens' TableMetadata (Maybe [Column])
- tableMetadata_lastAccessTime :: Lens' TableMetadata (Maybe UTCTime)
- tableMetadata_partitionKeys :: Lens' TableMetadata (Maybe [Column])
- tableMetadata_createTime :: Lens' TableMetadata (Maybe UTCTime)
- tableMetadata_name :: Lens' TableMetadata Text
- data Tag = Tag' {}
- newTag :: Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag (Maybe Text)
- data UnprocessedNamedQueryId = UnprocessedNamedQueryId' {
- namedQueryId :: Maybe Text
- errorCode :: Maybe Text
- errorMessage :: Maybe Text
- newUnprocessedNamedQueryId :: UnprocessedNamedQueryId
- unprocessedNamedQueryId_namedQueryId :: Lens' UnprocessedNamedQueryId (Maybe Text)
- unprocessedNamedQueryId_errorCode :: Lens' UnprocessedNamedQueryId (Maybe Text)
- unprocessedNamedQueryId_errorMessage :: Lens' UnprocessedNamedQueryId (Maybe Text)
- data UnprocessedQueryExecutionId = UnprocessedQueryExecutionId' {}
- newUnprocessedQueryExecutionId :: UnprocessedQueryExecutionId
- unprocessedQueryExecutionId_errorCode :: Lens' UnprocessedQueryExecutionId (Maybe Text)
- unprocessedQueryExecutionId_queryExecutionId :: Lens' UnprocessedQueryExecutionId (Maybe Text)
- unprocessedQueryExecutionId_errorMessage :: Lens' UnprocessedQueryExecutionId (Maybe Text)
- data WorkGroup = WorkGroup' {}
- newWorkGroup :: Text -> WorkGroup
- workGroup_creationTime :: Lens' WorkGroup (Maybe UTCTime)
- workGroup_state :: Lens' WorkGroup (Maybe WorkGroupState)
- workGroup_configuration :: Lens' WorkGroup (Maybe WorkGroupConfiguration)
- workGroup_description :: Lens' WorkGroup (Maybe Text)
- workGroup_name :: Lens' WorkGroup Text
- data WorkGroupConfiguration = WorkGroupConfiguration' {}
- newWorkGroupConfiguration :: WorkGroupConfiguration
- workGroupConfiguration_engineVersion :: Lens' WorkGroupConfiguration (Maybe EngineVersion)
- workGroupConfiguration_requesterPaysEnabled :: Lens' WorkGroupConfiguration (Maybe Bool)
- workGroupConfiguration_resultConfiguration :: Lens' WorkGroupConfiguration (Maybe ResultConfiguration)
- workGroupConfiguration_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfiguration (Maybe Natural)
- workGroupConfiguration_enforceWorkGroupConfiguration :: Lens' WorkGroupConfiguration (Maybe Bool)
- workGroupConfiguration_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfiguration (Maybe Bool)
- data WorkGroupConfigurationUpdates = WorkGroupConfigurationUpdates' {
- engineVersion :: Maybe EngineVersion
- requesterPaysEnabled :: Maybe Bool
- resultConfigurationUpdates :: Maybe ResultConfigurationUpdates
- bytesScannedCutoffPerQuery :: Maybe Natural
- removeBytesScannedCutoffPerQuery :: Maybe Bool
- enforceWorkGroupConfiguration :: Maybe Bool
- publishCloudWatchMetricsEnabled :: Maybe Bool
- newWorkGroupConfigurationUpdates :: WorkGroupConfigurationUpdates
- workGroupConfigurationUpdates_engineVersion :: Lens' WorkGroupConfigurationUpdates (Maybe EngineVersion)
- workGroupConfigurationUpdates_requesterPaysEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)
- workGroupConfigurationUpdates_resultConfigurationUpdates :: Lens' WorkGroupConfigurationUpdates (Maybe ResultConfigurationUpdates)
- workGroupConfigurationUpdates_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Natural)
- workGroupConfigurationUpdates_removeBytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)
- workGroupConfigurationUpdates_enforceWorkGroupConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)
- workGroupConfigurationUpdates_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool)
- data WorkGroupSummary = WorkGroupSummary' {}
- newWorkGroupSummary :: WorkGroupSummary
- workGroupSummary_creationTime :: Lens' WorkGroupSummary (Maybe UTCTime)
- workGroupSummary_engineVersion :: Lens' WorkGroupSummary (Maybe EngineVersion)
- workGroupSummary_state :: Lens' WorkGroupSummary (Maybe WorkGroupState)
- workGroupSummary_name :: Lens' WorkGroupSummary (Maybe Text)
- workGroupSummary_description :: Lens' WorkGroupSummary (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2017-05-18
of the Amazon Athena SDK configuration.
Errors
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that the request was throttled.
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates a platform issue, which may be due to a transient condition or outage.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A resource, such as a workgroup, was not found.
ColumnNullable
newtype ColumnNullable Source #
pattern ColumnNullable_NOT_NULL :: ColumnNullable | |
pattern ColumnNullable_NULLABLE :: ColumnNullable | |
pattern ColumnNullable_UNKNOWN :: ColumnNullable |
Instances
DataCatalogType
newtype DataCatalogType Source #
pattern DataCatalogType_GLUE :: DataCatalogType | |
pattern DataCatalogType_HIVE :: DataCatalogType | |
pattern DataCatalogType_LAMBDA :: DataCatalogType |
Instances
EncryptionOption
newtype EncryptionOption Source #
pattern EncryptionOption_CSE_KMS :: EncryptionOption | |
pattern EncryptionOption_SSE_KMS :: EncryptionOption | |
pattern EncryptionOption_SSE_S3 :: EncryptionOption |
Instances
QueryExecutionState
newtype QueryExecutionState Source #
pattern QueryExecutionState_CANCELLED :: QueryExecutionState | |
pattern QueryExecutionState_FAILED :: QueryExecutionState | |
pattern QueryExecutionState_QUEUED :: QueryExecutionState | |
pattern QueryExecutionState_RUNNING :: QueryExecutionState | |
pattern QueryExecutionState_SUCCEEDED :: QueryExecutionState |
Instances
StatementType
newtype StatementType Source #
pattern StatementType_DDL :: StatementType | |
pattern StatementType_DML :: StatementType | |
pattern StatementType_UTILITY :: StatementType |
Instances
WorkGroupState
newtype WorkGroupState Source #
pattern WorkGroupState_DISABLED :: WorkGroupState | |
pattern WorkGroupState_ENABLED :: WorkGroupState |
Instances
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.
ColumnInfo' | |
|
Instances
Create a value of ColumnInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel: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.
columnInfo_scale :: Lens' ColumnInfo (Maybe Int) Source #
For DECIMAL
data types, specifies the total number of digits in the
fractional part of the value. Defaults to 0.
columnInfo_precision :: Lens' ColumnInfo (Maybe Int) Source #
For DECIMAL
data types, specifies the total number of digits, up to
38. For performance reasons, we recommend up to 18 digits.
columnInfo_schemaName :: Lens' ColumnInfo (Maybe Text) Source #
The schema name (database name) to which the query results belong.
columnInfo_catalogName :: Lens' ColumnInfo (Maybe Text) Source #
The catalog to which the query results belong.
columnInfo_caseSensitive :: Lens' ColumnInfo (Maybe Bool) Source #
Indicates whether values in the column are case-sensitive.
columnInfo_label :: Lens' ColumnInfo (Maybe Text) Source #
A column label.
columnInfo_tableName :: Lens' ColumnInfo (Maybe Text) Source #
The table name for the query results.
columnInfo_nullable :: Lens' ColumnInfo (Maybe ColumnNullable) Source #
Indicates the column's nullable status.
columnInfo_name :: Lens' ColumnInfo Text Source #
The name of the column.
columnInfo_type :: Lens' ColumnInfo Text Source #
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.
DataCatalog' | |
|
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
HIVE
data catalog type, use the following syntax. Themetadata-function
parameter is required.The sdk-version
parameter is optional and defaults to the currently supported version.metadata-function=lambda_arn, sdk-version=version_number
For the
LAMBDA
data catalog type, use one of the following sets of required parameters, but not both.If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The
GLUE
type takes a catalog ID parameter and is required. Thecatalog_id
is the account ID of the Amazon Web Services account to which the Glue catalog belongs.catalog-id=catalog_id
- The
GLUE
data catalog type also applies to the defaultAwsDataCatalog
that already exists in your account, of which you can have only one and cannot modify. - Queries that specify a Glue Data Catalog other than the default
AwsDataCatalog
must be run on Athena engine version 2.
- The
$sel: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.
dataCatalog_parameters :: Lens' DataCatalog (Maybe (HashMap Text Text)) Source #
Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.
For the
HIVE
data catalog type, use the following syntax. Themetadata-function
parameter is required.The sdk-version
parameter is optional and defaults to the currently supported version.metadata-function=lambda_arn, sdk-version=version_number
For the
LAMBDA
data catalog type, use one of the following sets of required parameters, but not both.If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The
GLUE
type takes a catalog ID parameter and is required. Thecatalog_id
is the account ID of the Amazon Web Services account to which the Glue catalog belongs.catalog-id=catalog_id
- The
GLUE
data catalog type also applies to the defaultAwsDataCatalog
that already exists in your account, of which you can have only one and cannot modify. - Queries that specify a Glue Data Catalog other than the default
AwsDataCatalog
must be run on Athena engine version 2.
- The
dataCatalog_description :: Lens' DataCatalog (Maybe Text) Source #
An optional description of the data catalog.
dataCatalog_name :: Lens' DataCatalog Text Source #
The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
dataCatalog_type :: Lens' DataCatalog DataCatalogType Source #
The type of data catalog to create: LAMBDA
for a federated catalog,
HIVE
for an external hive metastore, or GLUE
for an Glue Data
Catalog.
DataCatalogSummary
data DataCatalogSummary Source #
The summary information for the data catalog, which includes its name and type.
See: newDataCatalogSummary
smart constructor.
DataCatalogSummary' | |
|
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.
dataCatalogSummary_catalogName :: Lens' DataCatalogSummary (Maybe Text) Source #
The name of the data catalog.
dataCatalogSummary_type :: Lens' DataCatalogSummary (Maybe DataCatalogType) Source #
The data catalog type.
Database
Contains metadata information for a database in a data catalog.
See: newDatabase
smart constructor.
Database' | |
|
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.
database_parameters :: Lens' Database (Maybe (HashMap Text Text)) Source #
A set of custom key/value pairs.
database_description :: Lens' Database (Maybe Text) Source #
An optional description of the database.
Datum
A piece of data (a field in the table).
See: newDatum
smart constructor.
Datum' | |
|
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.
EncryptionConfiguration' | |
|
Instances
newEncryptionConfiguration Source #
Create a value of EncryptionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:EncryptionConfiguration'
, encryptionConfiguration_kmsKey
- For SSE-KMS
and CSE-KMS
, this is the KMS key ARN or ID.
$sel:encryptionOption:EncryptionConfiguration'
, encryptionConfiguration_encryptionOption
- Indicates whether Amazon S3 server-side encryption with Amazon
S3-managed keys (SSE-S3
), server-side encryption with KMS-managed keys
(SSE-KMS
), or client-side encryption with KMS-managed keys (CSE-KMS)
is used.
If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration (Maybe Text) Source #
For SSE-KMS
and CSE-KMS
, this is the KMS key ARN or ID.
encryptionConfiguration_encryptionOption :: Lens' EncryptionConfiguration EncryptionOption Source #
Indicates whether Amazon S3 server-side encryption with Amazon
S3-managed keys (SSE-S3
), server-side encryption with KMS-managed keys
(SSE-KMS
), or client-side encryption with KMS-managed keys (CSE-KMS)
is used.
If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
EngineVersion
data EngineVersion Source #
The Athena engine version for running queries.
See: newEngineVersion
smart constructor.
EngineVersion' | |
|
Instances
newEngineVersion :: EngineVersion Source #
Create a value of EngineVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:effectiveEngineVersion:EngineVersion'
, engineVersion_effectiveEngineVersion
- Read only. The engine version on which the query runs. If the user
requests a valid engine version other than Auto, the effective engine
version is the same as the engine version that the user requested. If
the user requests Auto, the effective engine version is chosen by
Athena. When a request to update the engine version is made by a
CreateWorkGroup
or UpdateWorkGroup
operation, the
EffectiveEngineVersion
field is ignored.
$sel:selectedEngineVersion:EngineVersion'
, engineVersion_selectedEngineVersion
- The engine version requested by the user. Possible values are determined
by the output of ListEngineVersions
, including Auto. The default is
Auto.
engineVersion_effectiveEngineVersion :: Lens' EngineVersion (Maybe Text) Source #
Read only. The engine version on which the query runs. If the user
requests a valid engine version other than Auto, the effective engine
version is the same as the engine version that the user requested. If
the user requests Auto, the effective engine version is chosen by
Athena. When a request to update the engine version is made by a
CreateWorkGroup
or UpdateWorkGroup
operation, the
EffectiveEngineVersion
field is ignored.
engineVersion_selectedEngineVersion :: Lens' EngineVersion (Maybe Text) Source #
The engine version requested by the user. Possible values are determined
by the output of ListEngineVersions
, including Auto. The default is
Auto.
NamedQuery
data NamedQuery Source #
A query, where QueryString
is the list of SQL query statements that
comprise the query.
See: newNamedQuery
smart constructor.
NamedQuery' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> NamedQuery |
Create a value of NamedQuery
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel: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.
namedQuery_namedQueryId :: Lens' NamedQuery (Maybe Text) Source #
The unique identifier of the query.
namedQuery_description :: Lens' NamedQuery (Maybe Text) Source #
The query description.
namedQuery_workGroup :: Lens' NamedQuery (Maybe Text) Source #
The name of the workgroup that contains the named query.
namedQuery_name :: Lens' NamedQuery Text Source #
The query name.
namedQuery_database :: Lens' NamedQuery Text Source #
The database to which the query belongs.
namedQuery_queryString :: Lens' NamedQuery Text Source #
The SQL query statements that comprise the query.
PreparedStatement
data PreparedStatement Source #
A prepared SQL statement for use with Athena.
See: newPreparedStatement
smart constructor.
PreparedStatement' | |
|
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.
preparedStatement_lastModifiedTime :: Lens' PreparedStatement (Maybe UTCTime) Source #
The last modified time of the prepared statement.
preparedStatement_queryStatement :: Lens' PreparedStatement (Maybe Text) Source #
The query string for the prepared statement.
preparedStatement_statementName :: Lens' PreparedStatement (Maybe Text) Source #
The name of the prepared statement.
preparedStatement_description :: Lens' PreparedStatement (Maybe Text) Source #
The description of the prepared statement.
preparedStatement_workGroupName :: Lens' PreparedStatement (Maybe Text) Source #
The name of the workgroup to which the prepared statement belongs.
PreparedStatementSummary
data PreparedStatementSummary Source #
The name and last modified time of the prepared statement.
See: newPreparedStatementSummary
smart constructor.
PreparedStatementSummary' | |
|
Instances
newPreparedStatementSummary :: PreparedStatementSummary Source #
Create a value of PreparedStatementSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastModifiedTime:PreparedStatementSummary'
, preparedStatementSummary_lastModifiedTime
- The last modified time of the prepared statement.
$sel:statementName:PreparedStatementSummary'
, preparedStatementSummary_statementName
- The name of the prepared statement.
preparedStatementSummary_lastModifiedTime :: Lens' PreparedStatementSummary (Maybe UTCTime) Source #
The last modified time of the prepared statement.
preparedStatementSummary_statementName :: Lens' PreparedStatementSummary (Maybe Text) Source #
The name of the prepared statement.
QueryExecution
data QueryExecution Source #
Information about a single instance of a query execution.
See: newQueryExecution
smart constructor.
QueryExecution' | |
|
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.
queryExecution_engineVersion :: Lens' QueryExecution (Maybe EngineVersion) Source #
The engine version that executed the query.
queryExecution_status :: Lens' QueryExecution (Maybe QueryExecutionStatus) Source #
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
queryExecution_queryExecutionContext :: Lens' QueryExecution (Maybe QueryExecutionContext) Source #
The database in which the query execution occurred.
queryExecution_resultConfiguration :: Lens' QueryExecution (Maybe ResultConfiguration) Source #
The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.
queryExecution_query :: Lens' QueryExecution (Maybe Text) Source #
The SQL query statements which the query execution ran.
queryExecution_statementType :: Lens' QueryExecution (Maybe StatementType) Source #
The type of query statement that was run. DDL
indicates DDL query
statements. DML
indicates DML (Data Manipulation Language) query
statements, such as CREATE TABLE AS SELECT
. UTILITY
indicates query
statements other than DDL and DML, such as SHOW CREATE TABLE
, or
DESCRIBE TABLE
.
queryExecution_statistics :: Lens' QueryExecution (Maybe QueryExecutionStatistics) Source #
Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.
queryExecution_queryExecutionId :: Lens' QueryExecution (Maybe Text) Source #
The unique identifier for each query execution.
queryExecution_workGroup :: Lens' QueryExecution (Maybe Text) Source #
The name of the workgroup in which the query ran.
QueryExecutionContext
data QueryExecutionContext Source #
The database and data catalog context in which the query execution occurs.
See: newQueryExecutionContext
smart constructor.
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.
queryExecutionContext_database :: Lens' QueryExecutionContext (Maybe Text) Source #
The name of the database used in the query execution. The database must exist in the catalog.
queryExecutionContext_catalog :: Lens' QueryExecutionContext (Maybe Text) Source #
The name of the data catalog used in the query execution.
QueryExecutionStatistics
data QueryExecutionStatistics Source #
The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.
See: newQueryExecutionStatistics
smart constructor.
QueryExecutionStatistics' | |
|
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.
queryExecutionStatistics_totalExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that Athena took to run the query.
queryExecutionStatistics_engineExecutionTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that the query took to execute.
queryExecutionStatistics_queryPlanningTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.
queryExecutionStatistics_dataScannedInBytes :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of bytes in the data that was queried.
queryExecutionStatistics_queryQueueTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.
queryExecutionStatistics_dataManifestLocation :: Lens' QueryExecutionStatistics (Maybe Text) Source #
The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.
queryExecutionStatistics_serviceProcessingTimeInMillis :: Lens' QueryExecutionStatistics (Maybe Integer) Source #
The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
QueryExecutionStatus
data QueryExecutionStatus Source #
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
See: newQueryExecutionStatus
smart constructor.
QueryExecutionStatus' | |
|
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.
queryExecutionStatus_state :: Lens' QueryExecutionStatus (Maybe QueryExecutionState) Source #
The state of query execution. QUEUED
indicates that the query has been
submitted to the service, and Athena will execute the query as soon as
resources are available. RUNNING
indicates that the query is in
execution phase. SUCCEEDED
indicates that the query completed without
errors. FAILED
indicates that the query experienced an error and did
not complete processing. CANCELLED
indicates that a user input
interrupted query execution.
Athena automatically retries your queries in cases of certain transient
errors. As a result, you may see the query state transition from
RUNNING
or FAILED
to QUEUED
.
queryExecutionStatus_stateChangeReason :: Lens' QueryExecutionStatus (Maybe Text) Source #
Further detail about the status of the query.
queryExecutionStatus_submissionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime) Source #
The date and time that the query was submitted.
queryExecutionStatus_completionDateTime :: Lens' QueryExecutionStatus (Maybe UTCTime) Source #
The date and time that the query completed.
ResultConfiguration
data ResultConfiguration Source #
The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.
See: newResultConfiguration
smart constructor.
ResultConfiguration' | |
|
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.
resultConfiguration_encryptionConfiguration :: Lens' ResultConfiguration (Maybe EncryptionConfiguration) Source #
If query results are encrypted in Amazon S3, indicates the encryption
option used (for example, SSE-KMS
or CSE-KMS
) and key information.
This is a client-side setting. If workgroup settings override
client-side settings, then the query uses the encryption configuration
that is specified for the workgroup, and also uses the location for
storing query results specified in the workgroup. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration and
Workgroup Settings Override Client-Side Settings.
resultConfiguration_outputLocation :: Lens' ResultConfiguration (Maybe Text) Source #
The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/
. To run the query, you must specify
the query results location using one of the ways: either for individual
queries using either this setting (client-side), or in the workgroup,
using WorkGroupConfiguration. If none of them is set, Athena issues an
error that no output location is provided. For more information, see
Query Results.
If workgroup settings override client-side settings, then the query uses
the settings specified for the workgroup. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
ResultConfigurationUpdates
data ResultConfigurationUpdates Source #
The information about the updates in the query results, such as output location and encryption configuration for the query results.
See: newResultConfigurationUpdates
smart constructor.
ResultConfigurationUpdates' | |
|
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.
resultConfigurationUpdates_removeOutputLocation :: Lens' ResultConfigurationUpdates (Maybe Bool) Source #
If set to "true", indicates that the previously-specified query
results location (also known as a client-side setting) for queries in
this workgroup should be ignored and set to null. If set to "false" or
not set, and a value is present in the OutputLocation
in
ResultConfigurationUpdates
(the client-side setting), the
OutputLocation
in the workgroup's ResultConfiguration
will be
updated with the new value. For more information, see
Workgroup Settings Override Client-Side Settings.
resultConfigurationUpdates_removeEncryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe Bool) Source #
If set to "true", indicates that the previously-specified encryption
configuration (also known as the client-side setting) for queries in
this workgroup should be ignored and set to null. If set to "false" or
not set, and a value is present in the EncryptionConfiguration
in
ResultConfigurationUpdates
(the client-side setting), the
EncryptionConfiguration
in the workgroup's ResultConfiguration
will
be updated with the new value. For more information, see
Workgroup Settings Override Client-Side Settings.
resultConfigurationUpdates_encryptionConfiguration :: Lens' ResultConfigurationUpdates (Maybe EncryptionConfiguration) Source #
The encryption configuration for the query results.
resultConfigurationUpdates_outputLocation :: Lens' ResultConfigurationUpdates (Maybe Text) Source #
The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/
. For more information, see
Query Results
If workgroup settings override client-side settings, then the query uses
the location for the query results and the encryption configuration that
are specified for the workgroup. The "workgroup settings override" is
specified in EnforceWorkGroupConfiguration
(true/false) in the
WorkGroupConfiguration
. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
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.
ResultSet' | |
|
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.
resultSet_resultSetMetadata :: Lens' ResultSet (Maybe ResultSetMetadata) Source #
The metadata that describes the column structure and data types of a table of query results.
ResultSetMetadata
data ResultSetMetadata Source #
The metadata that describes the column structure and data types of a
table of query results. To return a ResultSetMetadata
object, use
GetQueryResults.
See: newResultSetMetadata
smart constructor.
ResultSetMetadata' | |
|
Instances
newResultSetMetadata :: ResultSetMetadata Source #
Create a value of ResultSetMetadata
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columnInfo:ResultSetMetadata'
, resultSetMetadata_columnInfo
- Information about the columns returned in a query result metadata.
resultSetMetadata_columnInfo :: Lens' ResultSetMetadata (Maybe [ColumnInfo]) Source #
Information about the columns returned in a query result metadata.
Row
The rows that 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.
row_data :: Lens' Row (Maybe [Datum]) Source #
The data that populates a row in a query result table.
TableMetadata
data TableMetadata Source #
Contains metadata for a table.
See: newTableMetadata
smart constructor.
TableMetadata' | |
|
Instances
Create a value of TableMetadata
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel: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.
tableMetadata_tableType :: Lens' TableMetadata (Maybe Text) Source #
The type of table. In Athena, only EXTERNAL_TABLE
is supported.
tableMetadata_parameters :: Lens' TableMetadata (Maybe (HashMap Text Text)) Source #
A set of custom key/value pairs for table properties.
tableMetadata_columns :: Lens' TableMetadata (Maybe [Column]) Source #
A list of the columns in the table.
tableMetadata_lastAccessTime :: Lens' TableMetadata (Maybe UTCTime) Source #
The last time the table was accessed.
tableMetadata_partitionKeys :: Lens' TableMetadata (Maybe [Column]) Source #
A list of the partition keys in the table.
tableMetadata_createTime :: Lens' TableMetadata (Maybe UTCTime) Source #
The time that the table was created.
tableMetadata_name :: Lens' TableMetadata Text Source #
The name of the table.
Tag
A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.
See: newTag
smart constructor.
Tag' | |
|
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.
tag_value :: Lens' Tag (Maybe Text) Source #
A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.
tag_key :: Lens' Tag (Maybe Text) Source #
A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.
UnprocessedNamedQueryId
data UnprocessedNamedQueryId Source #
Information about a named query ID that could not be processed.
See: newUnprocessedNamedQueryId
smart constructor.
UnprocessedNamedQueryId' | |
|
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.
unprocessedNamedQueryId_namedQueryId :: Lens' UnprocessedNamedQueryId (Maybe Text) Source #
The unique identifier of the named query.
unprocessedNamedQueryId_errorCode :: Lens' UnprocessedNamedQueryId (Maybe Text) Source #
The error code returned when the processing request for the named query failed, if applicable.
unprocessedNamedQueryId_errorMessage :: Lens' UnprocessedNamedQueryId (Maybe Text) Source #
The error message returned when the processing request for the named query failed, if applicable.
UnprocessedQueryExecutionId
data UnprocessedQueryExecutionId Source #
Describes a query execution that failed to process.
See: newUnprocessedQueryExecutionId
smart constructor.
UnprocessedQueryExecutionId' | |
|
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.
unprocessedQueryExecutionId_errorCode :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #
The error code returned when the query execution failed to process, if applicable.
unprocessedQueryExecutionId_queryExecutionId :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #
The unique identifier of the query execution.
unprocessedQueryExecutionId_errorMessage :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #
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.
WorkGroup' | |
|
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.
workGroup_creationTime :: Lens' WorkGroup (Maybe UTCTime) Source #
The date and time the workgroup was created.
workGroup_state :: Lens' WorkGroup (Maybe WorkGroupState) Source #
The state of the workgroup: ENABLED or DISABLED.
workGroup_configuration :: Lens' WorkGroup (Maybe WorkGroupConfiguration) Source #
The configuration of the workgroup, which includes the location in
Amazon S3 where query results are stored, the encryption configuration,
if any, used for query results; whether the Amazon CloudWatch Metrics
are enabled for the workgroup; whether workgroup settings override
client-side settings; and the data usage limits for the amount of data
scanned per query or per workgroup. The workgroup settings override is
specified in EnforceWorkGroupConfiguration
(true/false) in the
WorkGroupConfiguration
. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
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.
WorkGroupConfiguration' | |
|
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.
workGroupConfiguration_engineVersion :: Lens' WorkGroupConfiguration (Maybe EngineVersion) Source #
The engine version that all queries running on the workgroup use.
Queries on the AmazonAthenaPreviewFunctionality
workgroup run on the
preview engine regardless of this setting.
workGroupConfiguration_requesterPaysEnabled :: Lens' WorkGroupConfiguration (Maybe Bool) Source #
If set to true
, allows members assigned to a workgroup to reference
Amazon S3 Requester Pays buckets in queries. If set to false
,
workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error.
The default is false
. For more information about Requester Pays
buckets, see
Requester Pays Buckets
in the Amazon Simple Storage Service Developer Guide.
workGroupConfiguration_resultConfiguration :: Lens' WorkGroupConfiguration (Maybe ResultConfiguration) Source #
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.
workGroupConfiguration_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfiguration (Maybe Natural) Source #
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
workGroupConfiguration_enforceWorkGroupConfiguration :: Lens' WorkGroupConfiguration (Maybe Bool) Source #
If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
workGroupConfiguration_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfiguration (Maybe Bool) Source #
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.
WorkGroupConfigurationUpdates' | |
|
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.
workGroupConfigurationUpdates_engineVersion :: Lens' WorkGroupConfigurationUpdates (Maybe EngineVersion) Source #
The engine version requested when a workgroup is updated. After the
update, all queries on the workgroup run on the requested engine
version. If no value was previously set, the default is Auto. Queries on
the AmazonAthenaPreviewFunctionality
workgroup run on the preview
engine regardless of this setting.
workGroupConfigurationUpdates_requesterPaysEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #
If set to true
, allows members assigned to a workgroup to specify
Amazon S3 Requester Pays buckets in queries. If set to false
,
workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error.
The default is false
. For more information about Requester Pays
buckets, see
Requester Pays Buckets
in the Amazon Simple Storage Service Developer Guide.
workGroupConfigurationUpdates_resultConfigurationUpdates :: Lens' WorkGroupConfigurationUpdates (Maybe ResultConfigurationUpdates) Source #
The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
workGroupConfigurationUpdates_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Natural) Source #
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
workGroupConfigurationUpdates_removeBytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #
Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
workGroupConfigurationUpdates_enforceWorkGroupConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #
If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
workGroupConfigurationUpdates_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #
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.
WorkGroupSummary' | |
|
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.
workGroupSummary_creationTime :: Lens' WorkGroupSummary (Maybe UTCTime) Source #
The workgroup creation date and time.
workGroupSummary_engineVersion :: Lens' WorkGroupSummary (Maybe EngineVersion) Source #
The engine version setting for all queries on the workgroup. Queries on
the AmazonAthenaPreviewFunctionality
workgroup run on the preview
engine regardless of this setting.
workGroupSummary_state :: Lens' WorkGroupSummary (Maybe WorkGroupState) Source #
The state of the workgroup.
workGroupSummary_name :: Lens' WorkGroupSummary (Maybe Text) Source #
The name of the workgroup.
workGroupSummary_description :: Lens' WorkGroupSummary (Maybe Text) Source #
The workgroup description.