libZSservicesZSamazonka-athenaZSamazonka-athena
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Athena.Types

Description

 
Synopsis

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 #

Constructors

ColumnNullable' 

Instances

Instances details
Eq ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

Ord ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

Read ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

Show ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

Generic ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

Associated Types

type Rep ColumnNullable :: Type -> Type #

NFData ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

Methods

rnf :: ColumnNullable -> () #

Hashable ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

ToJSON ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

ToJSONKey ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

FromJSON ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

FromJSONKey ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

ToLog ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

ToHeader ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

ToQuery ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

FromXML ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

ToXML ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

Methods

toXML :: ColumnNullable -> XML #

ToByteString ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

FromText ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

ToText ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

type Rep ColumnNullable Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnNullable

type Rep ColumnNullable = D1 ('MetaData "ColumnNullable" "Amazonka.Athena.Types.ColumnNullable" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'True) (C1 ('MetaCons "ColumnNullable'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromColumnNullable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataCatalogType

newtype DataCatalogType Source #

Constructors

DataCatalogType' 

Instances

Instances details
Eq DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

Ord DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

Read DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

Show DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

Generic DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

Associated Types

type Rep DataCatalogType :: Type -> Type #

NFData DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

Methods

rnf :: DataCatalogType -> () #

Hashable DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

ToJSON DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

ToJSONKey DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

FromJSON DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

FromJSONKey DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

ToLog DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

ToHeader DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

ToQuery DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

FromXML DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

ToXML DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

Methods

toXML :: DataCatalogType -> XML #

ToByteString DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

FromText DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

ToText DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

type Rep DataCatalogType Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogType

type Rep DataCatalogType = D1 ('MetaData "DataCatalogType" "Amazonka.Athena.Types.DataCatalogType" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'True) (C1 ('MetaCons "DataCatalogType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataCatalogType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EncryptionOption

newtype EncryptionOption Source #

Instances

Instances details
Eq EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

Ord EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

Read EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

Show EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

Generic EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

Associated Types

type Rep EncryptionOption :: Type -> Type #

NFData EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

Methods

rnf :: EncryptionOption -> () #

Hashable EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

ToJSON EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

ToJSONKey EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

FromJSON EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

FromJSONKey EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

ToLog EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

ToHeader EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

ToQuery EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

FromXML EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

ToXML EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

ToByteString EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

FromText EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

ToText EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

type Rep EncryptionOption Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionOption

type Rep EncryptionOption = D1 ('MetaData "EncryptionOption" "Amazonka.Athena.Types.EncryptionOption" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'True) (C1 ('MetaCons "EncryptionOption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEncryptionOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueryExecutionState

newtype QueryExecutionState Source #

Instances

Instances details
Eq QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

Ord QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

Read QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

Show QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

Generic QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

Associated Types

type Rep QueryExecutionState :: Type -> Type #

NFData QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

Methods

rnf :: QueryExecutionState -> () #

Hashable QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

ToJSON QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

ToJSONKey QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

FromJSON QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

FromJSONKey QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

ToLog QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

ToHeader QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

ToQuery QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

FromXML QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

ToXML QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

ToByteString QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

FromText QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

ToText QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

type Rep QueryExecutionState Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionState

type Rep QueryExecutionState = D1 ('MetaData "QueryExecutionState" "Amazonka.Athena.Types.QueryExecutionState" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'True) (C1 ('MetaCons "QueryExecutionState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQueryExecutionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

StatementType

newtype StatementType Source #

Constructors

StatementType' 

Instances

Instances details
Eq StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

Ord StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

Read StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

Show StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

Generic StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

Associated Types

type Rep StatementType :: Type -> Type #

NFData StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

Methods

rnf :: StatementType -> () #

Hashable StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

ToJSON StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

ToJSONKey StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

FromJSON StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

FromJSONKey StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

ToLog StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

ToHeader StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

ToQuery StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

FromXML StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

ToXML StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

Methods

toXML :: StatementType -> XML #

ToByteString StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

FromText StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

ToText StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

Methods

toText :: StatementType -> Text #

type Rep StatementType Source # 
Instance details

Defined in Amazonka.Athena.Types.StatementType

type Rep StatementType = D1 ('MetaData "StatementType" "Amazonka.Athena.Types.StatementType" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'True) (C1 ('MetaCons "StatementType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStatementType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

WorkGroupState

newtype WorkGroupState Source #

Constructors

WorkGroupState' 

Instances

Instances details
Eq WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

Ord WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

Read WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

Show WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

Generic WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

Associated Types

type Rep WorkGroupState :: Type -> Type #

NFData WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

Methods

rnf :: WorkGroupState -> () #

Hashable WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

ToJSON WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

ToJSONKey WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

FromJSON WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

FromJSONKey WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

ToLog WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

ToHeader WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

ToQuery WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

FromXML WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

ToXML WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

Methods

toXML :: WorkGroupState -> XML #

ToByteString WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

FromText WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

ToText WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

type Rep WorkGroupState Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupState

type Rep WorkGroupState = D1 ('MetaData "WorkGroupState" "Amazonka.Athena.Types.WorkGroupState" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'True) (C1 ('MetaCons "WorkGroupState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromWorkGroupState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Column

data Column Source #

Contains metadata for a column in a table.

See: newColumn smart constructor.

Constructors

Column' 

Fields

Instances

Instances details
Eq Column Source # 
Instance details

Defined in Amazonka.Athena.Types.Column

Methods

(==) :: Column -> Column -> Bool #

(/=) :: Column -> Column -> Bool #

Read Column Source # 
Instance details

Defined in Amazonka.Athena.Types.Column

Show Column Source # 
Instance details

Defined in Amazonka.Athena.Types.Column

Generic Column Source # 
Instance details

Defined in Amazonka.Athena.Types.Column

Associated Types

type Rep Column :: Type -> Type #

Methods

from :: Column -> Rep Column x #

to :: Rep Column x -> Column #

NFData Column Source # 
Instance details

Defined in Amazonka.Athena.Types.Column

Methods

rnf :: Column -> () #

Hashable Column Source # 
Instance details

Defined in Amazonka.Athena.Types.Column

Methods

hashWithSalt :: Int -> Column -> Int #

hash :: Column -> Int #

FromJSON Column Source # 
Instance details

Defined in Amazonka.Athena.Types.Column

type Rep Column Source # 
Instance details

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))))

newColumn Source #

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.

column_type :: Lens' Column (Maybe Text) Source #

The data type of the column.

column_comment :: Lens' Column (Maybe Text) Source #

Optional information about the column.

column_name :: Lens' Column Text Source #

The name of the column.

ColumnInfo

data ColumnInfo Source #

Information about the columns in a query execution result.

See: newColumnInfo smart constructor.

Constructors

ColumnInfo' 

Fields

Instances

Instances details
Eq ColumnInfo Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnInfo

Read ColumnInfo Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnInfo

Show ColumnInfo Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnInfo

Generic ColumnInfo Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnInfo

Associated Types

type Rep ColumnInfo :: Type -> Type #

NFData ColumnInfo Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnInfo

Methods

rnf :: ColumnInfo -> () #

Hashable ColumnInfo Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnInfo

FromJSON ColumnInfo Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnInfo

type Rep ColumnInfo Source # 
Instance details

Defined in Amazonka.Athena.Types.ColumnInfo

newColumnInfo Source #

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_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.

Constructors

DataCatalog' 

Fields

  • parameters :: Maybe (HashMap Text Text)

    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. The metadata-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. The catalog_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 default AwsDataCatalog 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.
  • description :: Maybe Text

    An optional description of the data catalog.

  • name :: Text

    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.

  • type' :: DataCatalogType

    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.

Instances

Instances details
Eq DataCatalog Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalog

Read DataCatalog Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalog

Show DataCatalog Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalog

Generic DataCatalog Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalog

Associated Types

type Rep DataCatalog :: Type -> Type #

NFData DataCatalog Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalog

Methods

rnf :: DataCatalog -> () #

Hashable DataCatalog Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalog

FromJSON DataCatalog Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalog

type Rep DataCatalog Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalog

type Rep DataCatalog = D1 ('MetaData "DataCatalog" "Amazonka.Athena.Types.DataCatalog" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "DataCatalog'" '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) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataCatalogType))))

newDataCatalog Source #

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. The metadata-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. The catalog_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 default AwsDataCatalog 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.

$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. The metadata-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. The catalog_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 default AwsDataCatalog 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.

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.

Constructors

DataCatalogSummary' 

Fields

Instances

Instances details
Eq DataCatalogSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogSummary

Read DataCatalogSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogSummary

Show DataCatalogSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogSummary

Generic DataCatalogSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogSummary

Associated Types

type Rep DataCatalogSummary :: Type -> Type #

NFData DataCatalogSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogSummary

Methods

rnf :: DataCatalogSummary -> () #

Hashable DataCatalogSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogSummary

FromJSON DataCatalogSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogSummary

type Rep DataCatalogSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.DataCatalogSummary

type Rep DataCatalogSummary = D1 ('MetaData "DataCatalogSummary" "Amazonka.Athena.Types.DataCatalogSummary" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "DataCatalogSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "catalogName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataCatalogType))))

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

data Database Source #

Contains metadata information for a database in a data catalog.

See: newDatabase smart constructor.

Constructors

Database' 

Fields

Instances

Instances details
Eq Database Source # 
Instance details

Defined in Amazonka.Athena.Types.Database

Read Database Source # 
Instance details

Defined in Amazonka.Athena.Types.Database

Show Database Source # 
Instance details

Defined in Amazonka.Athena.Types.Database

Generic Database Source # 
Instance details

Defined in Amazonka.Athena.Types.Database

Associated Types

type Rep Database :: Type -> Type #

Methods

from :: Database -> Rep Database x #

to :: Rep Database x -> Database #

NFData Database Source # 
Instance details

Defined in Amazonka.Athena.Types.Database

Methods

rnf :: Database -> () #

Hashable Database Source # 
Instance details

Defined in Amazonka.Athena.Types.Database

Methods

hashWithSalt :: Int -> Database -> Int #

hash :: Database -> Int #

FromJSON Database Source # 
Instance details

Defined in Amazonka.Athena.Types.Database

type Rep Database Source # 
Instance details

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))))

newDatabase Source #

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.

database_name :: Lens' Database Text Source #

The name of the database.

Datum

data Datum Source #

A piece of data (a field in the table).

See: newDatum smart constructor.

Constructors

Datum' 

Fields

Instances

Instances details
Eq Datum Source # 
Instance details

Defined in Amazonka.Athena.Types.Datum

Methods

(==) :: Datum -> Datum -> Bool #

(/=) :: Datum -> Datum -> Bool #

Read Datum Source # 
Instance details

Defined in Amazonka.Athena.Types.Datum

Show Datum Source # 
Instance details

Defined in Amazonka.Athena.Types.Datum

Methods

showsPrec :: Int -> Datum -> ShowS #

show :: Datum -> String #

showList :: [Datum] -> ShowS #

Generic Datum Source # 
Instance details

Defined in Amazonka.Athena.Types.Datum

Associated Types

type Rep Datum :: Type -> Type #

Methods

from :: Datum -> Rep Datum x #

to :: Rep Datum x -> Datum #

NFData Datum Source # 
Instance details

Defined in Amazonka.Athena.Types.Datum

Methods

rnf :: Datum -> () #

Hashable Datum Source # 
Instance details

Defined in Amazonka.Athena.Types.Datum

Methods

hashWithSalt :: Int -> Datum -> Int #

hash :: Datum -> Int #

FromJSON Datum Source # 
Instance details

Defined in Amazonka.Athena.Types.Datum

type Rep Datum Source # 
Instance details

Defined in Amazonka.Athena.Types.Datum

type Rep Datum = D1 ('MetaData "Datum" "Amazonka.Athena.Types.Datum" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "Datum'" 'PrefixI 'True) (S1 ('MetaSel ('Just "varCharValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDatum :: Datum Source #

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.

datum_varCharValue :: Lens' Datum (Maybe Text) Source #

The value of the datum.

EncryptionConfiguration

data EncryptionConfiguration Source #

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.

See: newEncryptionConfiguration smart constructor.

Constructors

EncryptionConfiguration' 

Fields

  • kmsKey :: Maybe Text

    For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

  • encryptionOption :: 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.

Instances

Instances details
Eq EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Read EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Show EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Generic EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Associated Types

type Rep EncryptionConfiguration :: Type -> Type #

NFData EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Methods

rnf :: EncryptionConfiguration -> () #

Hashable EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionConfiguration

ToJSON EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionConfiguration

FromJSON EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionConfiguration

type Rep EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.EncryptionConfiguration

type Rep EncryptionConfiguration = D1 ('MetaData "EncryptionConfiguration" "Amazonka.Athena.Types.EncryptionConfiguration" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "EncryptionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encryptionOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionOption)))

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.

Constructors

EngineVersion' 

Fields

  • effectiveEngineVersion :: Maybe Text

    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.

  • selectedEngineVersion :: Maybe Text

    The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including Auto. The default is Auto.

Instances

Instances details
Eq EngineVersion Source # 
Instance details

Defined in Amazonka.Athena.Types.EngineVersion

Read EngineVersion Source # 
Instance details

Defined in Amazonka.Athena.Types.EngineVersion

Show EngineVersion Source # 
Instance details

Defined in Amazonka.Athena.Types.EngineVersion

Generic EngineVersion Source # 
Instance details

Defined in Amazonka.Athena.Types.EngineVersion

Associated Types

type Rep EngineVersion :: Type -> Type #

NFData EngineVersion Source # 
Instance details

Defined in Amazonka.Athena.Types.EngineVersion

Methods

rnf :: EngineVersion -> () #

Hashable EngineVersion Source # 
Instance details

Defined in Amazonka.Athena.Types.EngineVersion

ToJSON EngineVersion Source # 
Instance details

Defined in Amazonka.Athena.Types.EngineVersion

FromJSON EngineVersion Source # 
Instance details

Defined in Amazonka.Athena.Types.EngineVersion

type Rep EngineVersion Source # 
Instance details

Defined in Amazonka.Athena.Types.EngineVersion

type Rep EngineVersion = D1 ('MetaData "EngineVersion" "Amazonka.Athena.Types.EngineVersion" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "EngineVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "effectiveEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "selectedEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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.

Constructors

NamedQuery' 

Fields

Instances

Instances details
Eq NamedQuery Source # 
Instance details

Defined in Amazonka.Athena.Types.NamedQuery

Read NamedQuery Source # 
Instance details

Defined in Amazonka.Athena.Types.NamedQuery

Show NamedQuery Source # 
Instance details

Defined in Amazonka.Athena.Types.NamedQuery

Generic NamedQuery Source # 
Instance details

Defined in Amazonka.Athena.Types.NamedQuery

Associated Types

type Rep NamedQuery :: Type -> Type #

NFData NamedQuery Source # 
Instance details

Defined in Amazonka.Athena.Types.NamedQuery

Methods

rnf :: NamedQuery -> () #

Hashable NamedQuery Source # 
Instance details

Defined in Amazonka.Athena.Types.NamedQuery

FromJSON NamedQuery Source # 
Instance details

Defined in Amazonka.Athena.Types.NamedQuery

type Rep NamedQuery Source # 
Instance details

Defined in Amazonka.Athena.Types.NamedQuery

type Rep NamedQuery = D1 ('MetaData "NamedQuery" "Amazonka.Athena.Types.NamedQuery" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "NamedQuery'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "namedQueryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newNamedQuery Source #

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_workGroup :: Lens' NamedQuery (Maybe Text) Source #

The name of the workgroup that contains the named query.

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.

Constructors

PreparedStatement' 

Fields

Instances

Instances details
Eq PreparedStatement Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatement

Read PreparedStatement Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatement

Show PreparedStatement Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatement

Generic PreparedStatement Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatement

Associated Types

type Rep PreparedStatement :: Type -> Type #

NFData PreparedStatement Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatement

Methods

rnf :: PreparedStatement -> () #

Hashable PreparedStatement Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatement

FromJSON PreparedStatement Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatement

type Rep PreparedStatement Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatement

type Rep PreparedStatement = D1 ('MetaData "PreparedStatement" "Amazonka.Athena.Types.PreparedStatement" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "PreparedStatement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "queryStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "statementName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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.

Constructors

PreparedStatementSummary' 

Fields

Instances

Instances details
Eq PreparedStatementSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatementSummary

Read PreparedStatementSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatementSummary

Show PreparedStatementSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatementSummary

Generic PreparedStatementSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatementSummary

Associated Types

type Rep PreparedStatementSummary :: Type -> Type #

NFData PreparedStatementSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatementSummary

Hashable PreparedStatementSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatementSummary

FromJSON PreparedStatementSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatementSummary

type Rep PreparedStatementSummary Source # 
Instance details

Defined in Amazonka.Athena.Types.PreparedStatementSummary

type Rep PreparedStatementSummary = D1 ('MetaData "PreparedStatementSummary" "Amazonka.Athena.Types.PreparedStatementSummary" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "PreparedStatementSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "statementName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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.

QueryExecution

data QueryExecution Source #

Information about a single instance of a query execution.

See: newQueryExecution smart constructor.

Constructors

QueryExecution' 

Fields

  • engineVersion :: Maybe EngineVersion

    The engine version that executed the query.

  • status :: Maybe QueryExecutionStatus

    The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

  • queryExecutionContext :: Maybe QueryExecutionContext

    The database in which the query execution occurred.

  • resultConfiguration :: Maybe 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.

  • query :: Maybe Text

    The SQL query statements which the query execution ran.

  • statementType :: Maybe 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.

  • statistics :: Maybe QueryExecutionStatistics

    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.

  • queryExecutionId :: Maybe Text

    The unique identifier for each query execution.

  • workGroup :: Maybe Text

    The name of the workgroup in which the query ran.

Instances

Instances details
Eq QueryExecution Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecution

Read QueryExecution Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecution

Show QueryExecution Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecution

Generic QueryExecution Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecution

Associated Types

type Rep QueryExecution :: Type -> Type #

NFData QueryExecution Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecution

Methods

rnf :: QueryExecution -> () #

Hashable QueryExecution Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecution

FromJSON QueryExecution Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecution

type Rep QueryExecution Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecution

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.

Constructors

QueryExecutionContext' 

Fields

  • database :: Maybe Text

    The name of the database used in the query execution. The database must exist in the catalog.

  • catalog :: Maybe Text

    The name of the data catalog used in the query execution.

Instances

Instances details
Eq QueryExecutionContext Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionContext

Read QueryExecutionContext Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionContext

Show QueryExecutionContext Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionContext

Generic QueryExecutionContext Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionContext

Associated Types

type Rep QueryExecutionContext :: Type -> Type #

NFData QueryExecutionContext Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionContext

Methods

rnf :: QueryExecutionContext -> () #

Hashable QueryExecutionContext Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionContext

ToJSON QueryExecutionContext Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionContext

FromJSON QueryExecutionContext Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionContext

type Rep QueryExecutionContext Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionContext

type Rep QueryExecutionContext = D1 ('MetaData "QueryExecutionContext" "Amazonka.Athena.Types.QueryExecutionContext" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "QueryExecutionContext'" 'PrefixI 'True) (S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "catalog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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.

Constructors

QueryExecutionStatistics' 

Fields

  • totalExecutionTimeInMillis :: Maybe Integer

    The number of milliseconds that Athena took to run the query.

  • engineExecutionTimeInMillis :: Maybe Integer

    The number of milliseconds that the query took to execute.

  • queryPlanningTimeInMillis :: Maybe Integer

    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.

  • dataScannedInBytes :: Maybe Integer

    The number of bytes in the data that was queried.

  • queryQueueTimeInMillis :: Maybe Integer

    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.

  • dataManifestLocation :: Maybe Text

    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.

  • serviceProcessingTimeInMillis :: Maybe Integer

    The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.

Instances

Instances details
Eq QueryExecutionStatistics Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatistics

Read QueryExecutionStatistics Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatistics

Show QueryExecutionStatistics Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatistics

Generic QueryExecutionStatistics Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatistics

Associated Types

type Rep QueryExecutionStatistics :: Type -> Type #

NFData QueryExecutionStatistics Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatistics

Hashable QueryExecutionStatistics Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatistics

FromJSON QueryExecutionStatistics Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatistics

type Rep QueryExecutionStatistics Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatistics

type Rep QueryExecutionStatistics = D1 ('MetaData "QueryExecutionStatistics" "Amazonka.Athena.Types.QueryExecutionStatistics" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "QueryExecutionStatistics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "totalExecutionTimeInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "engineExecutionTimeInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "queryPlanningTimeInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 ('MetaSel ('Just "dataScannedInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "queryQueueTimeInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "dataManifestLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serviceProcessingTimeInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

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_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.

Constructors

QueryExecutionStatus' 

Fields

  • state :: Maybe QueryExecutionState

    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.

  • stateChangeReason :: Maybe Text

    Further detail about the status of the query.

  • submissionDateTime :: Maybe POSIX

    The date and time that the query was submitted.

  • completionDateTime :: Maybe POSIX

    The date and time that the query completed.

Instances

Instances details
Eq QueryExecutionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatus

Read QueryExecutionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatus

Show QueryExecutionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatus

Generic QueryExecutionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatus

Associated Types

type Rep QueryExecutionStatus :: Type -> Type #

NFData QueryExecutionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatus

Methods

rnf :: QueryExecutionStatus -> () #

Hashable QueryExecutionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatus

FromJSON QueryExecutionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatus

type Rep QueryExecutionStatus Source # 
Instance details

Defined in Amazonka.Athena.Types.QueryExecutionStatus

type Rep QueryExecutionStatus = D1 ('MetaData "QueryExecutionStatus" "Amazonka.Athena.Types.QueryExecutionStatus" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "QueryExecutionStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryExecutionState)) :*: S1 ('MetaSel ('Just "stateChangeReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "submissionDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "completionDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

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.

ResultConfiguration

data ResultConfiguration Source #

The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.

See: newResultConfiguration smart constructor.

Constructors

ResultConfiguration' 

Fields

  • encryptionConfiguration :: Maybe 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.

  • outputLocation :: Maybe Text

    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.

Instances

Instances details
Eq ResultConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfiguration

Read ResultConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfiguration

Show ResultConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfiguration

Generic ResultConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfiguration

Associated Types

type Rep ResultConfiguration :: Type -> Type #

NFData ResultConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfiguration

Methods

rnf :: ResultConfiguration -> () #

Hashable ResultConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfiguration

ToJSON ResultConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfiguration

FromJSON ResultConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfiguration

type Rep ResultConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfiguration

type Rep ResultConfiguration = D1 ('MetaData "ResultConfiguration" "Amazonka.Athena.Types.ResultConfiguration" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "ResultConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration)) :*: S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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.

Constructors

ResultConfigurationUpdates' 

Fields

  • removeOutputLocation :: Maybe Bool

    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.

  • removeEncryptionConfiguration :: Maybe Bool

    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.

  • encryptionConfiguration :: Maybe EncryptionConfiguration

    The encryption configuration for the query results.

  • outputLocation :: Maybe Text

    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.

Instances

Instances details
Eq ResultConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Read ResultConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Show ResultConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Generic ResultConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Associated Types

type Rep ResultConfigurationUpdates :: Type -> Type #

NFData ResultConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

Hashable ResultConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

ToJSON ResultConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

type Rep ResultConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultConfigurationUpdates

type Rep ResultConfigurationUpdates = D1 ('MetaData "ResultConfigurationUpdates" "Amazonka.Athena.Types.ResultConfigurationUpdates" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "ResultConfigurationUpdates'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "removeOutputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "removeEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration)) :*: S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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_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

data ResultSet Source #

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' 

Fields

Instances

Instances details
Eq ResultSet Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSet

Read ResultSet Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSet

Show ResultSet Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSet

Generic ResultSet Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSet

Associated Types

type Rep ResultSet :: Type -> Type #

NFData ResultSet Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSet

Methods

rnf :: ResultSet -> () #

Hashable ResultSet Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSet

FromJSON ResultSet Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSet

type Rep ResultSet Source # 
Instance details

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_rows :: Lens' ResultSet (Maybe [Row]) Source #

The rows in the table.

resultSet_resultSetMetadata :: Lens' ResultSet (Maybe ResultSetMetadata) Source #

The metadata that describes the column structure and data types of a table of query results.

ResultSetMetadata

data ResultSetMetadata Source #

The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata object, use GetQueryResults.

See: newResultSetMetadata smart constructor.

Constructors

ResultSetMetadata' 

Fields

Instances

Instances details
Eq ResultSetMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSetMetadata

Read ResultSetMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSetMetadata

Show ResultSetMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSetMetadata

Generic ResultSetMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSetMetadata

Associated Types

type Rep ResultSetMetadata :: Type -> Type #

NFData ResultSetMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSetMetadata

Methods

rnf :: ResultSetMetadata -> () #

Hashable ResultSetMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSetMetadata

FromJSON ResultSetMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSetMetadata

type Rep ResultSetMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.ResultSetMetadata

type Rep ResultSetMetadata = D1 ('MetaData "ResultSetMetadata" "Amazonka.Athena.Types.ResultSetMetadata" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "ResultSetMetadata'" 'PrefixI 'True) (S1 ('MetaSel ('Just "columnInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ColumnInfo]))))

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

data Row Source #

The rows that comprise a query result table.

See: newRow smart constructor.

Constructors

Row' 

Fields

  • data' :: Maybe [Datum]

    The data that populates a row in a query result table.

Instances

Instances details
Eq Row Source # 
Instance details

Defined in Amazonka.Athena.Types.Row

Methods

(==) :: Row -> Row -> Bool #

(/=) :: Row -> Row -> Bool #

Read Row Source # 
Instance details

Defined in Amazonka.Athena.Types.Row

Show Row Source # 
Instance details

Defined in Amazonka.Athena.Types.Row

Methods

showsPrec :: Int -> Row -> ShowS #

show :: Row -> String #

showList :: [Row] -> ShowS #

Generic Row Source # 
Instance details

Defined in Amazonka.Athena.Types.Row

Associated Types

type Rep Row :: Type -> Type #

Methods

from :: Row -> Rep Row x #

to :: Rep Row x -> Row #

NFData Row Source # 
Instance details

Defined in Amazonka.Athena.Types.Row

Methods

rnf :: Row -> () #

Hashable Row Source # 
Instance details

Defined in Amazonka.Athena.Types.Row

Methods

hashWithSalt :: Int -> Row -> Int #

hash :: Row -> Int #

FromJSON Row Source # 
Instance details

Defined in Amazonka.Athena.Types.Row

type Rep Row Source # 
Instance details

Defined in Amazonka.Athena.Types.Row

type Rep Row = D1 ('MetaData "Row" "Amazonka.Athena.Types.Row" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "Row'" 'PrefixI 'True) (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Datum]))))

newRow :: Row Source #

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.

Constructors

TableMetadata' 

Fields

Instances

Instances details
Eq TableMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.TableMetadata

Read TableMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.TableMetadata

Show TableMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.TableMetadata

Generic TableMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.TableMetadata

Associated Types

type Rep TableMetadata :: Type -> Type #

NFData TableMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.TableMetadata

Methods

rnf :: TableMetadata -> () #

Hashable TableMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.TableMetadata

FromJSON TableMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.TableMetadata

type Rep TableMetadata Source # 
Instance details

Defined in Amazonka.Athena.Types.TableMetadata

newTableMetadata Source #

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.

Tag

data Tag Source #

A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

See: newTag smart constructor.

Constructors

Tag' 

Fields

  • value :: Maybe Text

    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.

  • key :: Maybe Text

    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.

Instances

Instances details
Eq Tag Source # 
Instance details

Defined in Amazonka.Athena.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Read Tag Source # 
Instance details

Defined in Amazonka.Athena.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.Athena.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

Generic Tag Source # 
Instance details

Defined in Amazonka.Athena.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

NFData Tag Source # 
Instance details

Defined in Amazonka.Athena.Types.Tag

Methods

rnf :: Tag -> () #

Hashable Tag Source # 
Instance details

Defined in Amazonka.Athena.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

ToJSON Tag Source # 
Instance details

Defined in Amazonka.Athena.Types.Tag

FromJSON Tag Source # 
Instance details

Defined in Amazonka.Athena.Types.Tag

type Rep Tag Source # 
Instance details

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))))

newTag :: Tag Source #

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.

Constructors

UnprocessedNamedQueryId' 

Fields

  • namedQueryId :: Maybe Text

    The unique identifier of the named query.

  • errorCode :: Maybe Text

    The error code returned when the processing request for the named query failed, if applicable.

  • errorMessage :: Maybe Text

    The error message returned when the processing request for the named query failed, if applicable.

Instances

Instances details
Eq UnprocessedNamedQueryId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedNamedQueryId

Read UnprocessedNamedQueryId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedNamedQueryId

Show UnprocessedNamedQueryId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedNamedQueryId

Generic UnprocessedNamedQueryId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedNamedQueryId

Associated Types

type Rep UnprocessedNamedQueryId :: Type -> Type #

NFData UnprocessedNamedQueryId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedNamedQueryId

Methods

rnf :: UnprocessedNamedQueryId -> () #

Hashable UnprocessedNamedQueryId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedNamedQueryId

FromJSON UnprocessedNamedQueryId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedNamedQueryId

type Rep UnprocessedNamedQueryId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedNamedQueryId

type Rep UnprocessedNamedQueryId = D1 ('MetaData "UnprocessedNamedQueryId" "Amazonka.Athena.Types.UnprocessedNamedQueryId" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "UnprocessedNamedQueryId'" 'PrefixI 'True) (S1 ('MetaSel ('Just "namedQueryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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_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.

Constructors

UnprocessedQueryExecutionId' 

Fields

Instances

Instances details
Eq UnprocessedQueryExecutionId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedQueryExecutionId

Read UnprocessedQueryExecutionId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedQueryExecutionId

Show UnprocessedQueryExecutionId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedQueryExecutionId

Generic UnprocessedQueryExecutionId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedQueryExecutionId

Associated Types

type Rep UnprocessedQueryExecutionId :: Type -> Type #

NFData UnprocessedQueryExecutionId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedQueryExecutionId

Hashable UnprocessedQueryExecutionId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedQueryExecutionId

FromJSON UnprocessedQueryExecutionId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedQueryExecutionId

type Rep UnprocessedQueryExecutionId Source # 
Instance details

Defined in Amazonka.Athena.Types.UnprocessedQueryExecutionId

type Rep UnprocessedQueryExecutionId = D1 ('MetaData "UnprocessedQueryExecutionId" "Amazonka.Athena.Types.UnprocessedQueryExecutionId" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "UnprocessedQueryExecutionId'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "queryExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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_errorMessage :: Lens' UnprocessedQueryExecutionId (Maybe Text) Source #

The error message returned when the query execution failed to process, if applicable.

WorkGroup

data WorkGroup Source #

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

See: newWorkGroup smart constructor.

Constructors

WorkGroup' 

Fields

  • creationTime :: Maybe POSIX

    The date and time the workgroup was created.

  • state :: Maybe WorkGroupState

    The state of the workgroup: ENABLED or DISABLED.

  • configuration :: Maybe WorkGroupConfiguration

    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.

  • description :: Maybe Text

    The workgroup description.

  • name :: Text

    The workgroup name.

Instances

Instances details
Eq WorkGroup Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroup

Read WorkGroup Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroup

Show WorkGroup Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroup

Generic WorkGroup Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroup

Associated Types

type Rep WorkGroup :: Type -> Type #

NFData WorkGroup Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroup

Methods

rnf :: WorkGroup -> () #

Hashable WorkGroup Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroup

FromJSON WorkGroup Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroup

type Rep WorkGroup Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroup

type Rep WorkGroup = D1 ('MetaData "WorkGroup" "Amazonka.Athena.Types.WorkGroup" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "WorkGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkGroupState))) :*: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkGroupConfiguration)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newWorkGroup Source #

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.

workGroup_description :: Lens' WorkGroup (Maybe Text) Source #

The workgroup description.

workGroup_name :: Lens' WorkGroup Text Source #

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' 

Fields

  • engineVersion :: Maybe 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.

  • requesterPaysEnabled :: Maybe Bool

    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.

  • resultConfiguration :: Maybe 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.

  • bytesScannedCutoffPerQuery :: Maybe Natural

    The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

  • enforceWorkGroupConfiguration :: Maybe Bool

    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.

  • publishCloudWatchMetricsEnabled :: Maybe Bool

    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

Instances

Instances details
Eq WorkGroupConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfiguration

Read WorkGroupConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfiguration

Show WorkGroupConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfiguration

Generic WorkGroupConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfiguration

Associated Types

type Rep WorkGroupConfiguration :: Type -> Type #

NFData WorkGroupConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfiguration

Methods

rnf :: WorkGroupConfiguration -> () #

Hashable WorkGroupConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfiguration

ToJSON WorkGroupConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfiguration

FromJSON WorkGroupConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfiguration

type Rep WorkGroupConfiguration Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfiguration

type Rep WorkGroupConfiguration = D1 ('MetaData "WorkGroupConfiguration" "Amazonka.Athena.Types.WorkGroupConfiguration" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "WorkGroupConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineVersion)) :*: (S1 ('MetaSel ('Just "requesterPaysEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "resultConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResultConfiguration)))) :*: (S1 ('MetaSel ('Just "bytesScannedCutoffPerQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "enforceWorkGroupConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "publishCloudWatchMetricsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

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.

Constructors

WorkGroupConfigurationUpdates' 

Fields

Instances

Instances details
Eq WorkGroupConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates

Read WorkGroupConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates

Show WorkGroupConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates

Generic WorkGroupConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates

Associated Types

type Rep WorkGroupConfigurationUpdates :: Type -> Type #

NFData WorkGroupConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates

Hashable WorkGroupConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates

ToJSON WorkGroupConfigurationUpdates Source # 
Instance details

Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates

type Rep WorkGroupConfigurationUpdates Source # 
Instance details

Defined in