Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.Athena.StartQueryExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Runs (executes) the SQL query statements contained in the Query string.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide .

Creating a Request

startQueryExecution Source #

Arguments

:: Text	`sqeQueryString`
-> ResultConfiguration	`sqeResultConfiguration`
-> StartQueryExecution

Creates a value of StartQueryExecution with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sqeQueryExecutionContext - The database within which the query executes.
sqeClientRequestToken - A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString , an error is returned. Important: This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.
sqeQueryString - The SQL query statements to be executed.
sqeResultConfiguration - Specifies information about where and how to save the results of the query execution.

data StartQueryExecution Source #

See: startQueryExecution smart constructor.

Instances

Eq StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods (==) :: StartQueryExecution -> StartQueryExecution -> Bool # (/=) :: StartQueryExecution -> StartQueryExecution -> Bool #
Data StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartQueryExecution -> c StartQueryExecution # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartQueryExecution # toConstr :: StartQueryExecution -> Constr # dataTypeOf :: StartQueryExecution -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StartQueryExecution) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartQueryExecution) # gmapT :: (forall b. Data b => b -> b) -> StartQueryExecution -> StartQueryExecution # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartQueryExecution -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartQueryExecution -> r # gmapQ :: (forall d. Data d => d -> u) -> StartQueryExecution -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartQueryExecution -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartQueryExecution -> m StartQueryExecution # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartQueryExecution -> m StartQueryExecution # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartQueryExecution -> m StartQueryExecution #
Read StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods readsPrec :: Int -> ReadS StartQueryExecution # readList :: ReadS [StartQueryExecution] # readPrec :: ReadPrec StartQueryExecution # readListPrec :: ReadPrec [StartQueryExecution] #
Show StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods showsPrec :: Int -> StartQueryExecution -> ShowS # show :: StartQueryExecution -> String # showList :: [StartQueryExecution] -> ShowS #
Generic StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Associated Types type Rep StartQueryExecution :: Type -> Type # Methods from :: StartQueryExecution -> Rep StartQueryExecution x # to :: Rep StartQueryExecution x -> StartQueryExecution #
Hashable StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods hashWithSalt :: Int -> StartQueryExecution -> Int # hash :: StartQueryExecution -> Int #
ToJSON StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods toJSON :: StartQueryExecution -> Value # toEncoding :: StartQueryExecution -> Encoding # toJSONList :: [StartQueryExecution] -> Value # toEncodingList :: [StartQueryExecution] -> Encoding #
AWSRequest StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Associated Types type Rs StartQueryExecution :: Type # Methods request :: StartQueryExecution -> Request StartQueryExecution # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy StartQueryExecution -> ClientResponse -> m (Response StartQueryExecution) #
ToHeaders StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods toHeaders :: StartQueryExecution -> [Header] #
ToPath StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods toPath :: StartQueryExecution -> ByteString #
ToQuery StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods toQuery :: StartQueryExecution -> QueryString #
NFData StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods rnf :: StartQueryExecution -> () #
type Rep StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution type Rep StartQueryExecution = D1 (MetaData "StartQueryExecution" "Network.AWS.Athena.StartQueryExecution" "amazonka-athena-1.6.1-3l4hGXnA3w2LezY8q3vNku" False) (C1 (MetaCons "StartQueryExecution'" PrefixI True) ((S1 (MetaSel (Just "_sqeQueryExecutionContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe QueryExecutionContext)) :: S1 (MetaSel (Just "_sqeClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_sqeQueryString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sqeResultConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResultConfiguration))))
type Rs StartQueryExecution Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution type Rs StartQueryExecution = StartQueryExecutionResponse

Request Lenses

sqeQueryExecutionContext :: Lens' StartQueryExecution (Maybe QueryExecutionContext) Source #

The database within which the query executes.

sqeClientRequestToken :: Lens' StartQueryExecution (Maybe Text) Source #

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString , an error is returned. Important: This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.

sqeQueryString :: Lens' StartQueryExecution Text Source #

The SQL query statements to be executed.

sqeResultConfiguration :: Lens' StartQueryExecution ResultConfiguration Source #

Specifies information about where and how to save the results of the query execution.

Destructuring the Response

startQueryExecutionResponse Source #

Arguments

:: Int	`sqersResponseStatus`
-> StartQueryExecutionResponse

Creates a value of StartQueryExecutionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sqersQueryExecutionId - The unique ID of the query that ran as a result of this request.
sqersResponseStatus - -- | The response status code.

data StartQueryExecutionResponse Source #

See: startQueryExecutionResponse smart constructor.

Instances

Eq StartQueryExecutionResponse Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods (==) :: StartQueryExecutionResponse -> StartQueryExecutionResponse -> Bool # (/=) :: StartQueryExecutionResponse -> StartQueryExecutionResponse -> Bool #
Data StartQueryExecutionResponse Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartQueryExecutionResponse -> c StartQueryExecutionResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartQueryExecutionResponse # toConstr :: StartQueryExecutionResponse -> Constr # dataTypeOf :: StartQueryExecutionResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StartQueryExecutionResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartQueryExecutionResponse) # gmapT :: (forall b. Data b => b -> b) -> StartQueryExecutionResponse -> StartQueryExecutionResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartQueryExecutionResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartQueryExecutionResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> StartQueryExecutionResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartQueryExecutionResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartQueryExecutionResponse -> m StartQueryExecutionResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartQueryExecutionResponse -> m StartQueryExecutionResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartQueryExecutionResponse -> m StartQueryExecutionResponse #
Read StartQueryExecutionResponse Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods readsPrec :: Int -> ReadS StartQueryExecutionResponse # readList :: ReadS [StartQueryExecutionResponse] # readPrec :: ReadPrec StartQueryExecutionResponse # readListPrec :: ReadPrec [StartQueryExecutionResponse] #
Show StartQueryExecutionResponse Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods showsPrec :: Int -> StartQueryExecutionResponse -> ShowS # show :: StartQueryExecutionResponse -> String # showList :: [StartQueryExecutionResponse] -> ShowS #
Generic StartQueryExecutionResponse Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Associated Types type Rep StartQueryExecutionResponse :: Type -> Type # Methods from :: StartQueryExecutionResponse -> Rep StartQueryExecutionResponse x # to :: Rep StartQueryExecutionResponse x -> StartQueryExecutionResponse #
NFData StartQueryExecutionResponse Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution Methods rnf :: StartQueryExecutionResponse -> () #
type Rep StartQueryExecutionResponse Source #
Instance details Defined in Network.AWS.Athena.StartQueryExecution type Rep StartQueryExecutionResponse = D1 (MetaData "StartQueryExecutionResponse" "Network.AWS.Athena.StartQueryExecution" "amazonka-athena-1.6.1-3l4hGXnA3w2LezY8q3vNku" False) (C1 (MetaCons "StartQueryExecutionResponse'" PrefixI True) (S1 (MetaSel (Just "_sqersQueryExecutionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sqersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

sqersQueryExecutionId :: Lens' StartQueryExecutionResponse (Maybe Text) Source #

The unique ID of the query that ran as a result of this request.

sqersResponseStatus :: Lens' StartQueryExecutionResponse Int Source #

- | The response status code.