Amazonka.Athena.Types.QueryExecution

Documentation

data QueryExecution

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.

• executionParameters :: Maybe (NonEmpty Text)

  A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

• query :: Maybe Text

  The SQL query statements which the query execution ran.

• queryExecutionContext :: Maybe QueryExecutionContext

  The database in which the query execution occurred.

• queryExecutionId :: Maybe Text

  The unique identifier for each query execution.

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

• resultReuseConfiguration :: Maybe ResultReuseConfiguration

  Specifies the query result reuse behavior that was used for the query.

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

• status :: Maybe QueryExecutionStatus

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

• workGroup :: Maybe Text

  The name of the workgroup in which the query ran.

Instances

FromJSON QueryExecution

Defined in Amazonka.Athena.Types.QueryExecution

Methods

parseJSON :: Value -> Parser QueryExecution

parseJSONList :: Value -> Parser [QueryExecution]

Generic QueryExecution

Defined in Amazonka.Athena.Types.QueryExecution

Associated Types

type Rep QueryExecution :: Type -> Type

Methods

from :: QueryExecution -> Rep QueryExecution x

to :: Rep QueryExecution x -> QueryExecution

Read QueryExecution

Defined in Amazonka.Athena.Types.QueryExecution

Methods

readsPrec :: Int -> ReadS QueryExecution

readList :: ReadS [QueryExecution]

readPrec :: ReadPrec QueryExecution

readListPrec :: ReadPrec [QueryExecution]

Show QueryExecution

Defined in Amazonka.Athena.Types.QueryExecution

Methods

showsPrec :: Int -> QueryExecution -> ShowS

show :: QueryExecution -> String

showList :: [QueryExecution] -> ShowS

NFData QueryExecution

Defined in Amazonka.Athena.Types.QueryExecution

Methods

rnf :: QueryExecution -> ()

Eq QueryExecution

Defined in Amazonka.Athena.Types.QueryExecution

Methods

(==) :: QueryExecution -> QueryExecution -> Bool

(/=) :: QueryExecution -> QueryExecution -> Bool

Hashable QueryExecution

Defined in Amazonka.Athena.Types.QueryExecution

Methods

hashWithSalt :: Int -> QueryExecution -> Int

hash :: QueryExecution -> Int

type Rep QueryExecution

Defined in Amazonka.Athena.Types.QueryExecution

type Rep QueryExecution = D1 ('MetaData "QueryExecution" "Amazonka.Athena.Types.QueryExecution" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "QueryExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineVersion)) :*: S1 ('MetaSel ('Just "executionParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "queryExecutionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryExecutionContext)) :*: S1 ('MetaSel ('Just "queryExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "resultConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResultConfiguration)) :*: (S1 ('MetaSel ('Just "resultReuseConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResultReuseConfiguration)) :*: S1 ('MetaSel ('Just "statementType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatementType)))) :*: (S1 ('MetaSel ('Just "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryExecutionStatistics)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryExecutionStatus)) :*: S1 ('MetaSel ('Just "workGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newQueryExecution :: QueryExecution

Create a value of QueryExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:engineVersion:QueryExecution', queryExecution_engineVersion - The engine version that executed the query.

$sel:executionParameters:QueryExecution', queryExecution_executionParameters - A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

$sel:query:QueryExecution', queryExecution_query - The SQL query statements which the query execution ran.

$sel:queryExecutionContext:QueryExecution', queryExecution_queryExecutionContext - The database in which the query execution occurred.

$sel:queryExecutionId:QueryExecution', queryExecution_queryExecutionId - The unique identifier for each query execution.

$sel:resultConfiguration:QueryExecution', queryExecution_resultConfiguration - The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

$sel:resultReuseConfiguration:QueryExecution', queryExecution_resultReuseConfiguration - Specifies the query result reuse behavior that was used for the query.

$sel:statementType:QueryExecution', queryExecution_statementType - The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.

$sel:statistics:QueryExecution', queryExecution_statistics - Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.

$sel:status:QueryExecution', queryExecution_status - The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

$sel:workGroup:QueryExecution', queryExecution_workGroup - The name of the workgroup in which the query ran.

queryExecution_engineVersion :: Lens' QueryExecution (Maybe EngineVersion)

The engine version that executed the query.

queryExecution_executionParameters :: Lens' QueryExecution (Maybe (NonEmpty Text))

A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

queryExecution_query :: Lens' QueryExecution (Maybe Text)

The SQL query statements which the query execution ran.

queryExecution_queryExecutionContext :: Lens' QueryExecution (Maybe QueryExecutionContext)

The database in which the query execution occurred.

queryExecution_queryExecutionId :: Lens' QueryExecution (Maybe Text)

The unique identifier for each query execution.

queryExecution_resultConfiguration :: Lens' QueryExecution (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.

queryExecution_resultReuseConfiguration :: Lens' QueryExecution (Maybe ResultReuseConfiguration)

Specifies the query result reuse behavior that was used for the query.

queryExecution_statementType :: Lens' QueryExecution (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.

queryExecution_statistics :: Lens' QueryExecution (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.

queryExecution_status :: Lens' QueryExecution (Maybe QueryExecutionStatus)

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

queryExecution_workGroup :: Lens' QueryExecution (Maybe Text)

The name of the workgroup in which the query ran.