Network.AWS.Athena.StartQueryExecution

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

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

See: startQueryExecution smart constructor.

Instances

Eq StartQueryExecution

Methods

(==) :: StartQueryExecution -> StartQueryExecution -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS StartQueryExecution

readList :: ReadS [StartQueryExecution]

readPrec :: ReadPrec StartQueryExecution

readListPrec :: ReadPrec [StartQueryExecution]

Show StartQueryExecution

Methods

showsPrec :: Int -> StartQueryExecution -> ShowS

show :: StartQueryExecution -> String

showList :: [StartQueryExecution] -> ShowS

Generic StartQueryExecution

Associated Types

type Rep StartQueryExecution :: * -> *

Methods

from :: StartQueryExecution -> Rep StartQueryExecution x

to :: Rep StartQueryExecution x -> StartQueryExecution

Hashable StartQueryExecution

Methods

hashWithSalt :: Int -> StartQueryExecution -> Int

hash :: StartQueryExecution -> Int

ToJSON StartQueryExecution

Methods

toJSON :: StartQueryExecution -> Value

toEncoding :: StartQueryExecution -> Encoding

toJSONList :: [StartQueryExecution] -> Value

toEncodingList :: [StartQueryExecution] -> Encoding

NFData StartQueryExecution

Methods

rnf :: StartQueryExecution -> ()

AWSRequest StartQueryExecution

Associated Types

type Rs StartQueryExecution :: *

Methods

request :: StartQueryExecution -> Request StartQueryExecution

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * StartQueryExecution -> ClientResponse -> m (Response StartQueryExecution)

ToHeaders StartQueryExecution

Methods

toHeaders :: StartQueryExecution -> [Header]

ToPath StartQueryExecution

Methods

toPath :: StartQueryExecution -> ByteString

ToQuery StartQueryExecution

Methods

toQuery :: StartQueryExecution -> QueryString

type Rep StartQueryExecution

type Rep StartQueryExecution = D1 * (MetaData "StartQueryExecution" "Network.AWS.Athena.StartQueryExecution" "amazonka-athena-1.6.0-KugH04EmDfr8lF2gyqYv3y" False) (C1 * (MetaCons "StartQueryExecution'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sqeQueryExecutionContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe QueryExecutionContext))) (S1 * (MetaSel (Just Symbol "_sqeClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sqeQueryString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sqeResultConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ResultConfiguration)))))

type Rs StartQueryExecution

type Rs StartQueryExecution = StartQueryExecutionResponse

Request Lenses

sqeQueryExecutionContext :: Lens' StartQueryExecution (Maybe QueryExecutionContext)

The database within which the query executes.

sqeClientRequestToken :: Lens' StartQueryExecution (Maybe Text)

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

The SQL query statements to be executed.

sqeResultConfiguration :: Lens' StartQueryExecution ResultConfiguration

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

Destructuring the Response

startQueryExecutionResponse

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

See: startQueryExecutionResponse smart constructor.

Instances

Eq StartQueryExecutionResponse

Methods

(==) :: StartQueryExecutionResponse -> StartQueryExecutionResponse -> Bool

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

Data StartQueryExecutionResponse

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

Methods

readsPrec :: Int -> ReadS StartQueryExecutionResponse

readList :: ReadS [StartQueryExecutionResponse]

readPrec :: ReadPrec StartQueryExecutionResponse

readListPrec :: ReadPrec [StartQueryExecutionResponse]

Show StartQueryExecutionResponse

Methods

showsPrec :: Int -> StartQueryExecutionResponse -> ShowS

show :: StartQueryExecutionResponse -> String

showList :: [StartQueryExecutionResponse] -> ShowS

Generic StartQueryExecutionResponse

Associated Types

type Rep StartQueryExecutionResponse :: * -> *

Methods

from :: StartQueryExecutionResponse -> Rep StartQueryExecutionResponse x

to :: Rep StartQueryExecutionResponse x -> StartQueryExecutionResponse

NFData StartQueryExecutionResponse

Methods

rnf :: StartQueryExecutionResponse -> ()

type Rep StartQueryExecutionResponse

type Rep StartQueryExecutionResponse = D1 * (MetaData "StartQueryExecutionResponse" "Network.AWS.Athena.StartQueryExecution" "amazonka-athena-1.6.0-KugH04EmDfr8lF2gyqYv3y" False) (C1 * (MetaCons "StartQueryExecutionResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sqersQueryExecutionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sqersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

sqersQueryExecutionId :: Lens' StartQueryExecutionResponse (Maybe Text)

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

sqersResponseStatus :: Lens' StartQueryExecutionResponse Int

• - | The response status code.